[解決済み] Sphinxのautodocは十分に自動化されていない
2022-05-02 17:02:14
質問
Sphinxを使って、Pythonの5,000行以上のプロジェクトを文書化しようとしています。それは約7つの基本モジュールを持っています。私が知っている限りでは、autodocを使うためには、プロジェクトの各ファイルに対して、次のようなコードを書く必要があります。
.. automodule:: mods.set.tests
:members:
:show-inheritance:
ファイル数が多いので、これは面倒くさい。mods' パッケージをドキュメント化するように指定できれば、もっと簡単です。そうすれば、Sphinxは再帰的にパッケージを調べて、それぞれのサブモジュールのためのページを作ることができます。
このような機能はあるのでしょうか?なければ、すべての.rstファイルを作成するスクリプトを書くこともできますが、それには多くの時間を取られます。
解決方法は?
こちらをご覧ください。 スクリプト 私が作ったものです。あなたのお役に立てると思います。
このスクリプトは、ディレクトリツリーを解析して、Pythonのモジュールやパッケージを探し、Sphinxでコードのドキュメントを作成するために、適切にReSTファイルを作成します。また、モジュールのインデックスも作成します。
アップデイト
このスクリプトは現在、Sphinx 1.1 の一部である アピドック .
関連
-
Python 可視化 big_screen ライブラリ サンプル 詳細
-
風力制御におけるKS原理を深く理解するためのpythonアルゴリズム
-
[解決済み】RuntimeWarning: invalid value encountered in double_scalars で numpy の除算ができない。
-
[解決済み】DataFrameのコンストラクタが正しく呼び出されない!エラー
-
[解決済み】Python regex AttributeError: 'NoneType' オブジェクトに 'group' 属性がない。
-
[解決済み】ilocが「IndexError: single positional indexer is out-of-bounds」を出す。
-
[解決済み】csv.Error:イテレータはバイトではなく文字列を返すべき
-
[解決済み】TypeErrorを取得しました。エントリを持つ子テーブルの後に親テーブルを追加しようとすると、 __init__() missing 1 required positional argument: 'on_delete'
-
[解決済み】NameError: 名前 'self' が定義されていません。
-
[解決済み】Flaskのテンプレートが見つからない【重複あり
最新
-
nginxです。[emerg] 0.0.0.0:80 への bind() に失敗しました (98: アドレスは既に使用中です)
-
htmlページでギリシャ文字を使うには
-
ピュアhtml+cssでの要素読み込み効果
-
純粋なhtml + cssで五輪を実現するサンプルコード
-
ナビゲーションバー・ドロップダウンメニューのHTML+CSSサンプルコード
-
タイピング効果を実現するピュアhtml+css
-
htmlの選択ボックスのプレースホルダー作成に関する質問
-
html css3 伸縮しない 画像表示効果
-
トップナビゲーションバーメニュー作成用HTML+CSS
-
html+css 実装 サイバーパンク風ボタン
おすすめ
-
ピロウズ画像色処理の具体的な活用方法
-
Pythonコンテナのための組み込み汎用関数操作
-
pyCaret効率化乗算器 オープンソース ローコード Python機械学習ツール
-
[解決済み】pygame.error: ビデオシステムが初期化されていない
-
[解決済み] データ型が理解できない
-
[解決済み】Pythonスクリプトで「Expected 2D array, got 1D array instead: 」というエラーが発生?
-
[解決済み】 AttributeError: モジュール 'matplotlib' には属性 'plot' がない。
-
[解決済み】インポートエラー。モジュール名 urllib2 がない
-
[解決済み】NameError: 名前 'self' が定義されていません。
-
[解決済み】 TypeError: += でサポートされていないオペランド型: 'int' および 'list' です。