Documentation Discussion

[addisonlynch]

fecon documentation

In-progress

Discussion thread for fecon236 documentation (from #4)

Overview

I have an initial Sphinx documentation implementation in the fecon-docs repository, which in part uses the sphinx-autodoc extension to render the docstrings ("auto-documentation"). There are also small sections which I have built out (such as FRED Codes) for additional context.

The repository is setup to use TravisCI with doctr for CI and CD to Github pages. The travis build lints the documentation source, though I do need to explore options for linting the docstrings themselves (there are a few, each of which have pros and cons).

General Structure

The documentation will be structured as a one-to-one mirror of the modules used in fecon236:

Implementation

Implementation will begin as auto-documentation of each fecon236 module.

In order to complete this process, it is easiest to convert all docstrings to the numpydoc format. An initial implementation of these conversions has been completed (see pull requests #10 through #24)

ATTN mention: @rsvp