-
-
Notifications
You must be signed in to change notification settings - Fork 553
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
Change docs to use Pydata theme #2618
Conversation
Codecov ReportBase: 99.69% // Head: 99.69% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## develop #2618 +/- ##
========================================
Coverage 99.69% 99.69%
========================================
Files 271 271
Lines 19570 19571 +1
========================================
+ Hits 19510 19511 +1
Misses 60 60
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Docs look like this on latest build: https://pybamm--2618.org.readthedocs.build/en/2618/ |
Almost ready to go, final problem is the code is not displaying on this page https://pybamm--2618.org.readthedocs.build/en/2618/source/user_guide/fundamentals/index.html (it's not displaying locally either) |
Found the problem, I was doing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation looks amazing! Thanks, @tinosulzer!
@@ -4,7 +4,6 @@ Plotting | |||
.. toctree:: | |||
|
|||
quick_plot | |||
dynamic_plot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this intentional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, the contents of that file are now in quick_plot
since they go together
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thanks! We should aim to merge this by Tuesday so we can have the new docs with the new release.
Description
This is the theme used by numpy, scipy, pandas, etc and looks much better than our current one.
Also did a little bit of reformatting, started a user guide, etc, but there is more to be done
Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
Key checklist:
$ flake8
$ python run-tests.py --unit
$ cd docs
and then$ make clean; make html
You can run all three at once, using
$ python run-tests.py --quick
.Further checks: