addisonlynch / addisonlynch/fecon-docs

Implementation Discussion

オープン
#2 コメント 1 件 リアクション 0 件 担当者 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 を短くまとめたダイジェスト。