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

Add autogenerated documentation with Sphinx #14

Merged
merged 2 commits into from
Oct 21, 2020

Conversation

cthoyt
Copy link
Contributor

@cthoyt cthoyt commented Oct 2, 2020

References #13 (but doesn't close it). After checking out this PR, you can learn a bit about how to use Sphinx to automatically incorporate your documentation into the Sphinx build. To build the docs, you'll start in the root of the repository and do the following in the bash:

pip install sphinx sphinx_rtd_theme # only have to do this once
cd docs
make html
open build/html/index.html

Rerun the make html command any time you make a change

@RemyLau RemyLau merged commit aef7b1e into krishnanlab:master Oct 21, 2020
@cthoyt cthoyt deleted the add-sphinx branch October 21, 2020 20:42
RemyLau added a commit that referenced this pull request Feb 16, 2021
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

2 participants