-
Notifications
You must be signed in to change notification settings - Fork 20
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
Sphinx documentation #126
Merged
Merged
Sphinx documentation #126
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
… so it can be find by sphinx
ckarwin
approved these changes
Jan 29, 2024
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.
Ready to be merged
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.
Automatic sphinx documentation.
Currently, it is built automatically from the
docs
branch, and deployed here: https://cositools.github.io/cosipy/Eventually, we can use the releases on the main branch and deployed to somewhere like https://cosi.ssl.berkeley.edu/cositools/cosipy
Here's how to compile it locally: https://cositools.github.io/cosipy/install.html#compiling-the-docs
Currently, you'll need to locally merge this branch (
docs
) into your branch before compiling in order to test changes to your docstrings and notebooks.Note: The
#
and##
in the markdown cells of your notebook now do matter. These correspond to the title and subtitles shown in the table of contents. There should be only one#
for the title. I fixed a couple of notebook in order to make it work. I'm also overriding the title of the notebooks for now in the table of contents, but eventually they need to be set by the notebook itself.As for the API section, I'm currently using autodocs to document the each module automatically. You can change the behaviour by going to the .rst of the module, for example: https://github.com/cositools/cosipy/blob/docs/docs/api/response.rst?plain=1
I'll leave this as draft for now because I need to add more explanatory text.