Public documentation - first stable version #18
Merged
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.
Use Sphinx with autodoc to automatically create documentation.
Public documentation only includes high-level classes, those designed as tasks or models.
The
Makefile
has been modified to include the install to modify docs and to build the html. The built has to be uploaded to the repository with the docs, no action to do this automatically has been added due to lack of permissions.make docs
will setup and install all needed for writing docs.make html
calls sphinx Makefile to build the HTML.