Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation (pydata-sphinx-theme broke our build) + migrate to myst-nb #731

Merged
merged 4 commits into from
Sep 9, 2022

Conversation

ma-sadeghi
Copy link
Member

@ma-sadeghi ma-sadeghi commented Sep 9, 2022

  • Switched over to myst-nb from nbsphinx as it seems to be more robust and has more useful features
  • Pinned pydata-sphinx-theme version to 0.9 to it won't break again!
  • Added a table of contents to the sidebar of the examples page
  • Fixed night mode
  • Removed "getting started", moved "installation" and "basic usage" up to root level for visibility
  • Lots of other aesthetic enhancements, similar to what we recently did to OpenPNM docs

@codecov
Copy link

codecov bot commented Sep 9, 2022

Codecov Report

Merging #731 (5fa0606) into dev (3b5f333) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##             dev    #731   +/-   ##
=====================================
  Coverage   83.8%   83.8%           
=====================================
  Files         36      36           
  Lines       4035    4035           
=====================================
  Hits        3385    3385           
  Misses       650     650           

@ma-sadeghi ma-sadeghi merged commit 7ce461f into dev Sep 9, 2022
@ma-sadeghi ma-sadeghi deleted the fix_docs branch September 9, 2022 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant