Write docstrings derived from OpenSCAD manual #40
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
This allows docs to be built with: tox -edocs
This will allow the README to also be included in the generated sphinx docs
This change adds docstrings which are suitable for sphinx autodoc generation. The OpenSCAD User Manual is licensed under the Creative Commons Attribution-ShareAlike License, and my research suggests that it is safe to mix this with LGPL code. These docs can be generated with tox -edocs It would be very useful now for these docs to be hosted on https://readthedocs.org/
etjones
added a commit
that referenced
this pull request
Oct 30, 2015
Write docstrings derived from OpenSCAD manual
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.
These changes add docstrings which are suitable for sphinx autodoc generation.
The OpenSCAD User Manual is licensed under the Creative Commons Attribution-ShareAlike License, and my research suggests that it is safe to mix this with LGPL code.
These docs can be generated with
tox -edocs
It would be very useful now for these docs to be hosted on https://readthedocs.org/