Generate reference documentation with Sphinx#41
Merged
rhempel merged 7 commits intoev3dev:masterfrom Oct 31, 2015
ddemidov:master
Merged
Generate reference documentation with Sphinx#41rhempel merged 7 commits intoev3dev:masterfrom ddemidov:master
rhempel merged 7 commits intoev3dev:masterfrom
ddemidov:master
Conversation
This was referenced Oct 31, 2015
Closed
Member
|
Would be nice if |
rhempel
added a commit
that referenced
this pull request
Oct 31, 2015
Generate reference documentation with Sphinx
Member
|
Thanks! |
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
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.
This adds sphinx configuration, so that refence documentation could be generated automatically. I've registered my own fork on the readthedocs site, so that you have an idea of how the generated doc would look like:
http://ev3dev-lang-python-1.readthedocs.org/en/latest/
Once this is merged, I'll register the main repo there. It may be setup to rebuild the documentation automatically after each commit pushed to github.