This is the folder for building the complete documentation for the Vibration Testing module. The actual documentation is hosted via githubpages.

The remainder of this document contains notes for developers.

To make the doc, in the docs folder type:

make docs

To serve the pages, move to the docs/_build/html folder and type:

python -m http.server

We shouldn't ever need this many.

All documentation will be built with via sphinx using make html in the docs directory. Updating on github is documented in the developers.rst file at the top of the repository.

Documentation of functions help (uses autodoc):

Module and function help needs to then follow the numpy convention.

For information on how function docstrings are used, see numpydoc

For plots: http://matplotlib.org/sampledoc/extensions.html