pybind / pybind/python_example
Building the docs
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 530
- フォーク
- 150
- 平均マージ
- 8日 2時間
- マージ済み PR（30日）
- 1
説明
Hi,
I can build the docs with Sphinx using make html but when I open the html files I can't see any of the function docstrings. I'm new to Sphinx so I might be missing something.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、ドキュメントに記載された Sphinx ビルドを make html で実行し、生成された HTML を Sphinx の設定と併せて調べます。Python 関数の docstring が含まれない理由を特定します。生成されたドキュメントにそれらの docstring が表示されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100