addisonlynch / addisonlynch/fecon-docs

Implementation Discussion

Abierto
#2 1 comentario 0 reacciones 1 asignado Reclamado por @rsvp Ver en GitHub
discussion
Lenguaje dominante
Python
Estrellas
2
Forks
1
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

# 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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.