addisonlynch / addisonlynch/fecon-docs

Implementation Discussion

Open
#2 1 comment 0 reactions 1 assignee Claimed by @rsvp View on GitHub
discussion
Dominant language
Python
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

# 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.