-
Notifications
You must be signed in to change notification settings - Fork 10
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
Refactor documentation for faster builds #12
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghisvail
force-pushed
the
docs/drop-jb
branch
2 times, most recently
from
January 31, 2024 08:37
a66d7b9
to
0d5c302
Compare
ghisvail
force-pushed
the
docs/drop-jb
branch
3 times, most recently
from
February 8, 2024 14:46
dfe5135
to
da6183c
Compare
ghisvail
force-pushed
the
docs/drop-jb
branch
3 times, most recently
from
February 21, 2024 11:20
03ac41f
to
3e4d014
Compare
Investigate using static API docs generation
|
ghisvail
force-pushed
the
docs/drop-jb
branch
from
February 22, 2024 15:35
b06edda
to
bb75f05
Compare
A few warnings sill:
|
ghisvail
force-pushed
the
docs/drop-jb
branch
2 times, most recently
from
February 22, 2024 16:51
e1a5849
to
f759a24
Compare
The docs now build fast and look fine on RTD for this PR. Some more xref and MyST parsing warnings to fix, but the end is near. |
ghisvail
force-pushed
the
docs/drop-jb
branch
4 times, most recently
from
February 28, 2024 15:28
0573969
to
87cd999
Compare
ghisvail
force-pushed
the
docs/drop-jb
branch
2 times, most recently
from
March 11, 2024 07:14
15c491e
to
3849483
Compare
Fixed API docs issues in #28 |
- Switch from Jupyter Book to Sphinx - Use sphinx-book-theme as docs theme - Use myst-parser for Markdown support - Add commands for incremental development - Generate API docs statically with sphinx-apidoc
Another set of fixes to the API docs summary in #30 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #11