search

shigeyukioba / matchernet

Apache License 2.0
1 stars 1 forks source link

docstring からドキュメントを生成する #23

Closed uchihashikenshi closed 4 years ago

uchihashikenshi commented 4 years ago

概要

ドキュメントを docstring から Sphinx を用いて自動生成する。

目的

docstring をコードで管理すること

提案内容

reStructuredText、Google style、Numpy style の3パターンがあるが、もともと書かれているドキュメントが Google style っぽかったのでそれを使用。

タスク

関連

uchihashikenshi commented 4 years ago

既に doc がありわかりづらかったので rename 。

uchihashikenshi commented 4 years ago

.rst の修正+make html or sphinx-apidoc で html が修正される。 各ドキュメントの修正は作業的に重くなりそうなので、個別に issue を立てたほうが良さそう。 公開に関しても、現在どこまでやるか見通しが見えていない部分もある。 なのでこちらは一旦 close 。