問題タブ [toctree]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
4 に答える
47936 参照

python-sphinx - 警告: ドキュメントは、インクルード ファイルのどの toctree にも含まれていません

警告が表示されます:

明示的に含まれているため、ドキュメントに存在するファイルの場合。だから私はインデックスファイルを持っています:

ファイル 0020-bar.rst には、次のように他の多くのファイルを具体的に含めています。

しかし、プロジェクトをビルドすると、次のように 0070-baz.rst がどの toctree にもないという警告が表示されます。

奇妙なことは、出力の内容を確認できることです。これは正常ですか?この警告は、toctree 経由ではなく、明示的に含まれているファイルに対して常に表示されますか?

0 投票する
0 に答える
508 参照

python-sphinx - toctree の見出しからリストへの連続番号付け

見出し番号から続けてリスト番号を取得しようとしています。:numbered:でディレクティブを試しました.. toctree:が、見出しの数字しか生成されません。

例えば:

生成されるもの:

1. Section

1.1 Sub Section

1.1.1 Item 1

1.1.2 Item 2

1.1.2.1 Item 3

この結果を生成するためのアプローチは(もしあれば)何ですか?

0 投票する
1 に答える
3271 参照

python-sphinx - Sphinx toctree はサイドバーに TOC を表示し、本文に箇条書きリストを表示するか、何も表示しません。

私は Sphinx (sphinx-1.2b1-py2.7) を使用しています。目次をサイドバーに表示したい。バイナリのようです: サイドバーの目次とテキスト本文の箇条書きリストの両方しか取得できないか、何も取得できません (サイドバーの目次と箇条書きリストはありません)。

次のように toctree ディレクティブを使用すると:

結果: サイドバーに TOC がなく、本文にトピックの箇条書きリストがありません。

次のように toctree ディレクティブを使用すると:

結果: サイドバーの目次と本文のトピックの箇条書きリスト。

サイドバーにTOCが欲しいだけです。他のコマンド (maxdepth、includehidden) は機能しません。私はそれが行われたのを見てきましたが、それを機能させることはできません。conf.py は問題ないように見えますが、答えを探して数日経ってもうまくいきません。ありがとう。

0 投票する
1 に答える
2810 参照

python-sphinx - クラスを Sphinx の TOC に表示する

ext.autodoc を使用して、いくつかの python クラスの文書化を開始しています。次のような内容の *.rst ファイルがいくつかあります。

プラス index.rst:

目次には「mymodule」が表示されていますが、TOC にもクラスを表示したいと思います。

  • 私のモジュール
    • myclassA
    • myclassB

各クラスのセクションのようなものをスフィンクスに作成させるにはどうすればよいですか? それともそうしない正当な理由がありますか?

ありがとう

0 投票する
3 に答える
19012 参照

python-sphinx - 各ページのサイドバーに toctree を含める方法

Sphinx で HTML ドキュメントを生成しています。

ドキュメント内の各 HTML ページのサイドバーを変更して、toctree を含めるにはどうすればよいですか? デフォルトでは、toctree はmaster_docページにのみ表示され、サイドバーではなくメイン エリアにのみ表示されます。

これを行う簡単な方法はありますか?生成されたドキュメントをホストするために readthedocs を使用するので、readthedocs でも利用できる場合を除き、サードパーティのプラグインの使用は避けたいと思います。

0 投票する
1 に答える
713 参照

html - Sphinx の目次のテンプレートを変更する

独自のテンプレートで Sphinx を使用して、Twitter のブートストラップ ドキュメントのようなドキュメント スタイルを取得しています: http://getbootstrap.com/2.3.2/getting-started.html

左側にナビゲーションが表示されます。これは静的で、スクロールしても同じ場所に留まります。

したがって、この関数で既に達成した目次をレンダリングする必要があります。

それは私に次のように出力します:

しかし、ブートストラップで機能させるには、次の出力が必要です。

私の質問は次のとおりです。どうすればそれを達成できますか? toctree()調整できる機能のテンプレートファイルはありますか?

0 投票する
2 に答える
3189 参照

python-sphinx - スフィンクス toctree のページ セクションにリンクするにはどうすればよいですか

パッケージ内.. toctreeの他のファイルへの相対リンクを含む sphinx ページの一部として があります。rstページ全体ではなく、特定のページのサブセクションへのリンクを含めるにはどうすればよいですか?

突き刺した

しかし、それはうまくいきませんでした。どんな助けも素晴らしいです。