Generate basic documentation using Sphinx #52
Merged
Conversation
This file contains hidden or 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
And also adds a Makefile to make building/viewing the docs a little easier.
The Makefile adds these commands:
install to install the datascience package locally
test to run the tests
docs to build the docs
clean_docs to remove the doc files
serve_docs to serve the docs from a local Python server
It now displays all the documentation in sections and allows for convenient browsing of modules in the sidebar.
Contributor
Author
Contributor
|
Great! Can you publish it? |
papajohn
added a commit
that referenced
this pull request
Sep 9, 2015
Generate basic documentation using Sphinx
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.
And also adds a Makefile to make building/viewing the docs a little easier.
The Makefile adds these commands:
This is what the docs currently look like:
It's not too hard to push the
docsfolder to Github pages so people can browse the docs online (https://gist.github.com/cobyism/4730490).