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

Sphinx documentation #126

Merged
merged 31 commits into from
Jan 29, 2024
Merged

Sphinx documentation #126

merged 31 commits into from
Jan 29, 2024

Conversation

israelmcmc
Copy link
Collaborator

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.

@israelmcmc israelmcmc marked this pull request as ready for review January 29, 2024 04:51
Copy link
Contributor

@ckarwin ckarwin left a 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

@israelmcmc israelmcmc merged commit 36459c7 into main Jan 29, 2024
2 checks passed
@israelmcmc israelmcmc deleted the docs branch March 24, 2024 19:34
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.

2 participants