Create sphinx documentation for Read the Docs #329
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
…ns in sphinx documentation
…NPATH is correct, hope so also on readthedocs
Let's make it easier for people to learn how to use the program
Add link do docs in README
|
I need to get a working py27 install to test get this to work ... |
|
I managed to get it working. Let me do a PR for that |
I can't believe that Python2 is giving us so much trouble during its last moments.
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.
Description
This replaces the old html file documentation by a sphinx source documentation that can be build to html, pdf and others.
I've also set up documentation on Read the Docs.
The documentation is based on earlier documentation files. I've tried to improve it the best I can. But there is a long way to go. This PR should make it easy to improve our documentation by including the source into the repo.
Fixes #171
Fixes #199
Fixes #118
Fixes #178
How Has This Been Tested?
I've added building and doctesting the documentation to the .travis-ci.yml so it is tested on every commit.
Checklist