addisonlynch / addisonlynch/fecon-docs

Implementation Discussion

未关闭
#2 1 条评论 0 个 reaction 已指派 1 人 已被 @rsvp 认领 在 GitHub 查看
discussion
主要语言
Python
星标
2
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

# 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

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。