-
Notifications
You must be signed in to change notification settings - Fork 54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation Discussion #25
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
The text was updated successfully, but these errors were encountered: