Documentation #20
Open
Documentation #20
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
This provides a documentation folder, ./docs, and the linux, Makefile, and windows, make.bat, scripts to build it. The output directory is currently setup as ./build but this can be changed.
This removes the sphinx build scripts, Makefile and make.bat, in favour of building the documentation through the package setup script, setup.py.
Ported the initial documentation from MarkDown into RST.
the sphinx folders .static and .templates are required for sphinx to compile but where ignored by git.
|
Thanks for this @Carelvd! Been a bit swamped recently but I'll try to take some time to review this soon. |
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.
Dear Ms. Cochrane,
I've ported your documentation from MarkDown to ReStructuredText to support Read the Docs and Sphinx. I simply copy/pasted everything from the original read me file into the structure expected by sphinx. I have gone through most of it to correcting the cross references and hyperlinks, sphinx does somewhat this differently from markdown, but the resulting readability/argument flow might have taken a knock.
I'm not sure if this is what you want for the project but I though if It where in the pipeline I might save you some time. If not simply block the PR.
Regards,
Carel van Dam