Add docs #414
Open
Add docs #414
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
added 2 commits
July 13, 2020 16:43
docsrc: Contains source code of the documentation in reStructuredText docs: Compiled HTML version of documentation to link to using github pages Makefile: convert docsrc to docs using "make github"
Contributor
|
Sorry, there's a lot of changed files to look through, Does this include the machinery to build the docs and host? |
Author
|
For building, there is a Makefile included in the PR. Use the target "make github" to build the docs folder. Note for convenience I have included a prebuilt docs folder. The HTML pages are intended to be served via github pages. To review locally just open docs/index.html in a browser. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What does this PR do?
Adds file format documentation to repo. The source for documents is located in docsrc/ and the compiled version to be served lives in docs/ (docs/ is created by running "make github").
Note, it is expected that docs will be linked to by "github pages" to serve documentation. Follow the directions found at https://www.docslikecode.com/articles/github-pages-python-sphinx/.
Checklist
CHANGELOG.txt.CONTRIBUTORS.txt.