Covert documentation to sphinx #157
Merged
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
Prior to this commit the documentation was built with asciidoc. This commit replaces that asciidoc build environment with Sphinx. Note: The asciidoc documentation file `doc.asciidoc` (renamed `index.rst` in this commit) is still asciidoc markdown. Though it builds with Sphinx the output mostly broken. A series of commits will follow this commit that will fix the formatting issues. Further reading: * http://www.sphinx-doc.org/en/1.4.8/ * http://www.sphinx-doc.org/en/1.4.8/tutorial.html
The leading dot is not significant in Structerdoc.
Possible issues: * This commit puts the images into the repository. They were probably left out intentionally, so this commit may need to be modified to pull the images from their real source.
Sphnix creates an index implicitly at the bottom of the page so an explicitly index creation is not required. Possible issues: * The index is at the bottom of the page; it used to be at the top. * The index is not numbered, neither are the sections.
|
Sorry for the delay, will try it and merge it asap |
|
@MattHardcastle would you be interested in #161? |
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 converts the documentation to Sphinx format. Sphinx is required for converting documentation to readthedocs #156 . If merged it should be trivial to get readthedocs.org setup. It doesn't contain changes to the
build-docs.shscript but that script can probably be removed after readthedocs.org is configured?Finally, this pull request is broken up into easy to follow commits. Your contribution guidelines mention you prefer a single commit for a change. I'm happy to squash the branch if you prefer.