下部にあるSphinxの警告をどのように修正できますか？

私は自分のPythonノートをSphinxに入れようとしています。index.rstと同じディレクトリレベルの別々のファイルにメモがあります。

HTMLをビルドした後、次の警告が表示されます

警告

の

構築時の完全なメッセージ

を使用してビルドしようとしてsphinx-build . docいますが、警告が表示されます:

その理由は何ですか？

私はSphinxを初めて使用し、サーバー上でプロジェクトを文書化しています。今、同僚が私がやっていることを見て、同じことをしたいと思っています。同じサーバーで自分のプロジェクトを文書化します。

プロジェクトは関連がなく (単一の TOCtree に属していません)、私は彼女を助ける方法がわかりません。別のドキュメント ツリーを構築するように sphinx を構成できますか? Makefile の 2 つのコピーを作成し、異なるソース/ビルド ディレクトリを設定するのと同じくらい簡単ですか?

ありがとう、 -- ティム

私はsphinxを使用してhtmlページを自動生成しています。目次は非常に長いので、JavaScriptライブラリを使用できるように（とりわけ）新しいhtmlクラスをtoctreeのdivに追加しようとしています。基本的に、toctreeがHTMLを生成する方法を変更したいと考えています。

globaltoc.htmlファイルを見つけ、それを_templatesフォルダーに配置し、conf.pyのtemplate_pathのコメントを解除しました。

これは、_templatesディレクトリ内のファイルです。

私がこれを完全に間違って行っている場合は、これを行う別の方法を教えてください。純粋なreSTでこれを実行できるようにしたいのですが、不可能のようです。Sphinxテンプレートの限られた例を見てきましたが、これが私が見つけることができるすべてです。

これの全体的な目標は、非常に大きなツリーで使用するためにdhtmlxTreeを使用することです。必要な.jsファイルと.cssファイルをlayout.htmlに追加しました。必要なクラスを作成するには、 toctreeを含むdivが必要です。手動で編集することで必要な結果を得ることができます。今度は自動化する必要があります。

ご協力いただきありがとうございます。

toctreeをファイル名の降順で並べ替えるオプションを知っている人はいますか？昇順の場合、次の:glob:ようなオプションを使用できます。

これは、Sphinxドキュメント内で報告する必要がある再構成されたテキストで書かれた毎日のメモに便利です。

非 Python プロジェクトの文書化に Sphinx を使用しています。そのモジュールを文書化するためのファイルを./doc含む、各サブモジュールのフォルダーを配布したいと考えています。submodule_name.rst次に、これらのファイルをマスター階層に吸い込み、デザイン全体の仕様を作成します。

すなわち:

次のように、マスターproject_spec.rstドキュメントの toctree にファイルを含めようとしました。

ただし、次のエラー メッセージが表示されます。

警告: toctree には、存在しないドキュメント u'modules/module1/docs/module1' への参照が含まれています

../どうにかドキュメントパスで使えないでしょうか？

更新: conf.py の場所を追加

更新: 以下のインクルード トリックを除いて、これはまだ (2019 年) 不可能です。前進し続ける未解決の問題があります: https://github.com/sphinx-doc/sphinx/issues/701

Sphinxでドキュメントを生成しています。目次のドキュメントへのリンクのラベルを変更できます

toctree ディレクティブに従って toctree ディレクティブを使用しますが、ドキュメント内のセクションへのリンクに対して同じことを行うにはどうすればよいですか?

編集 ：

これは私が達成したいことです:

doc.rst

そのSection - informationため、目次にInfo section表示されますが、ドキュメント自体に表示されます

Sphinx でドキュメントを生成しようとしましたが、生成が「ドキュメントの準備中..」でハングします。解決策を探していますが、問題を解決するためのアドバイスが見つかりません。

この問題は、すべてのファイルに目次を追加した後に発生します。ドキュメントの構造は次のようになります。

いくつかのモデル: すべてのモデルにはいくつかのテーブルがあります (テーブルごとに 1 つのファイル) 例:

• モデル = アウディトレイル
• テーブル = AUDITTRAIL_BFLOG.rst、AUDITTRAIL_SESSIONLOG.rst

AUDITRAIL.rst

AUDITTRAIL_SESSIONLOG.rst

AUDITTRAIL.SESSIONLOG

.. toctree:: :最大深度: 1

AUDITTRAIL.rst

キーとインデックス

===== ===== ==================== seq 型フィールド
===== ===== ======= ============= 1 P セッションログ ID 2 I USRID、セッションログ ID ===== ===== ================== =

田畑

===== ==================== ===== ===== ========== ===== ========== ==================== seq フィールド名 タイプ inDB インターフェイス ウィジェットタイプ 説明 =====
======== ============ ===== ===== ========== ================== ================ 5 CLIENTNAME SY W20 EDITBOX クライアント名 4 COMPUTERNAME S
Y W20 EDITBOX サーバー名 6
CREDATIM EY E8 EDITBOX 作成日フィールド 11 DESCR SY W1024
EDITBOXLONG 説明フィールド 10 LABEL S
○ W100 EDITBOX ラベルフィールド 1
SESSIONLOGID NY C10 EDITBOX Id フィールド 8 UPDDATIM EY E8
EDITBOX 更新日付フィールド 2 USRID N
Y C10 EDITBOX id ユーザー 7
USRIDCRE NY C10 EDITBOX 作成ユーザー ID フィールド 9 USRIDUPD NY C10
EDITBOX 更新ユーザー ID フィールド *3 USR_CODE S
N W30 EDITBOX * == === =================== ===== ===== ========== ======= ======== ====================

同じモデルの他のテーブルを参照するために、すべてのテーブル ファイルに目次を追加しました。誰かが私を助けてくれることを願っています。

あいさつ、ミーシャ

Sphinxを使用して大規模なPythonコードベースのAPIドキュメントを自動的に作成しようとしています。

build_modules.pyとsphinx-apidocを使用してみました。どちらを使用しても、パッケージとトップレベルモジュールの出力ディレクトリに最初のドキュメントを正常に作成できます。

ただし、を使用してビルドする場合

このタイプの何千ものエラーが発生します。

コードベース内のすべての単一のクラスとメソッドに対して。いくつかの実験で、autosummary / autoclassディレクティブが、すべてのクラスとメソッドに最初のファイルがあることを期待するtoctreeを作成していることを発見したと思います。

警告以外は、ドキュメントはうまく機能しているようですが、私はそれらを取り除きたいので、何かを誤って構成した可能性があると思います。

私もほぼ同じ効果でnipype/toolsを試しました。

apigen.pyとbuild_modref_templates.pyを変更して、これらの「欠落している」ドキュメントごとに、必要に応じてautoclass / autofunction/automethodsを使用して最初のスタブを作成しました。ただし、ビルドには非常に長い時間（10分）がかかり、最後のビルドステップでのメモリエラーが原因で最終的にクラッシュします。

すべての警告を作成するモジュールのrstファイルの例を次に示します。

これらの警告を解決する方法についてアドバイスをありがとうございます！sphinxサイトパッケージファイルの変更を伴うソリューションには近づかないようにしたいと思います。

私はスフィンクスを学ぼうとしていますが、基本的な例だけに固執しています。make htmlソースディレクトリので次のエラーが発生します。

introどちらも機能しないように見える代わりに、参照も試みintro.rstました。index.rstとintro.rst同じディレクトリにあります。sphinx-quickstartすべてのデフォルトオプションを使用してプロジェクトを作成しました。