addisonlynch / addisonlynch/fecon-docs
Implementation Discussion
- Lingua principale
- Python
- Stelle
- 2
- Fork
- 1
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
# Overview
This initial implementation is composed almost entirely of ``sphinx-autodoc`` auto-documentation, which was made possible by the conversion of the ``fecon236`` docstrings to numpy format. With this skeleton documentation pattern, we are able to maintain the level of commenting and explanation within the code. From there, we can, at a minimum, easily insert this into the documentation -- along with our own comments and more robust explanation.
# Installation
Checkout the ``rebuild-docstrings`` [branch](https://github.com/addisonlynch/fecon236/tree/rebuild-docstrings) on my fork of ``fecon236`` and install. This branch contains the correctly-formatted docstrings in order for ``sphinx-autodoc`` to work properly.
cc @rsvp, I will soon be updating this issue with a number of discussion items and questions
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Valutazione
Questa issue non è ancora stata valutata.