It's necessary for Sphinx to import them correctly.
Added rudimentary docstrings to all scripts
Ported the documentation of gemPlotter.py to a docstring. It can be built as part of the larger HTML documentation or as a stand-alone man page. In the future, the latter could be included in the pip and rpm packages.
The README will not be modified as long as the docs aren't hosted centrally.
I'm not yet sure about how to organize the documentation, but this can easily be changed later.
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Motivation and Context
Use a proper tool for documentation, Sphinx.
How Has This Been Tested?
Docs were built and published here. (Note that this can be ahead by a few commits.)
Screenshots
man displaying the man page:
lynx displaying the same in HTML:
Checklist:
[ ] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
bdorney
commented
6 years ago
Description
There are three main changes in this PR:
Modified some scripts to include:
It's necessary for Sphinx to import them correctly.
Added rudimentary docstrings to all scripts
Ported the documentation of
gemPlotter.pyto a docstring. It can be built as part of the larger HTML documentation or as a stand-alonemanpage. In the future, the latter could be included in thepipandrpmpackages.The README will not be modified as long as the docs aren't hosted centrally.
I'm not yet sure about how to organize the documentation, but this can easily be changed later.
Types of changes
Motivation and Context
Use a proper tool for documentation, Sphinx.
How Has This Been Tested?
Docs were built and published here. (Note that this can be ahead by a few commits.)
Screenshots
mandisplaying themanpage:lynxdisplaying the same in HTML:Checklist: