問題タブ [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 投票する
1 に答える
6359 参照

python - toctreeの下で別のドキュメントにリンクするスフィンクスを取得できません

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

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

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

python-sphinx - 個々のSphinx警告メッセージを無効にする

.rstSphinxツリーには、インデックスツリーから意図的に除外されているファイルがたくさんあります。次のような警告が表示されます

Sphinxで特定の警告を抑制するにはどうすればよいですか?

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

python-sphinx - 別のページの目次を Sphinx に含める

plugins/index.html に次のページがあります。

plugin/basics/index.html と plugins/advanced/index.html には、plugins/index.html にリストされている同じサブページにリンクする独自の toctree が含まれています。私が疑問に思っているのは、私がやっているようにサブページを手動でリストするのではなく、それらのサブ toctree を含める方法はありますか?

toctree から :hidden: フラグを削除するだけでよいことはわかっていますが、要点は、基本/高度なトピックを、独自の見出し、導入段落などを含む別のリストに保持したいということです。

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

python-sphinx - テーブル内に目次を作成する

テーブル内に目次を生成できるようにしたい。たとえば、境界線があり、次のようになります。

次のようなものからテーブルを自動生成したい:

出力は、html と pdf の両方です。

これはできますか?または、docutils パーサーなどを使用する必要がありますか?

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

python - Sphinx の toctree の明示的なタイトル

で要素のタイトルを明示的に設定しようとしていtoctreeます。ドキュメントには、次のようにする必要があると記載されています。

ただし、「文字列に関するすべて」ではなく、string.rst ドキュメントにあるもののタイトルを出力するだけです。

誰にもアイデアがありますか?

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

python - Sphinx で TOCTREE を取得してリンクを表示できない

私はスフィンクスが初めてです。チュートリアルを試してみましたが、コンテンツにリンクを生成できませんでした。私が得たエラー

と同じディレクトリにとを作成zuhdi.rstしました。ドキュメントにタイトルを付けるにはどうすればよいですか?intro.rstindex.rst

参考までに、私の index.rst には次の行が含まれています。

リンクを toctree に配置するには、ドキュメントが存在している必要がありますか? intro.rstandzuhdi.rstは単なる空のファイルです。

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

python - Sphinx のサイドバー toctree のすべてのサブセクションを展開するには?

ファイルに含まれているヘッダーの下のすべてのサブセクションを展開する方法があるかどうか疑問に思っていましたindex.rstか?

例として、その方法は次のとおりです。

そして、これが私が望む方法です:

セクション 1 をクリックするとその下が表示されますが、セクション 2 をクリックするとセクション 1 の内容が非表示になり、セクション 2 のみが表示されます。インデックス ページを表示するたびに、2 つのセクションすべてを展開したいと考えています。を追加しようとしましたがtoctreemaxdepth何も機能しません。

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

conditional-statements - Sphinx の条件付き toctree

含まれるセクションが異なるドキュメントの複数のバージョンを作成したいと考えています。これを実現するには、通常、onlyディレクティブまたはifconfig拡張機能を使用します。ただし、toctreeディレクティブと組み合わせて使用​​することはできません。

私が基本的に欲しいのは次のようなものです:

それを行う方法はありますか?

0 投票する
5 に答える
11958 参照

python-sphinx - メインの TOCTree から Sphinx サブセクションを非表示にする

メインの TOCTree から RST ファイルに存在する 1 つ (またはすべて) のサブセクションを非表示にすることは可能ですか?

もう少し説明しましょう:

index.rst

children/file.rst

これらのファイルは、ビルド後にメインの TOCTree になります。

  • ラベル
  • ラベル
  • 子供のラベル
    • 孫のラベル 1
    • 孫のレーベル2
    • 第1項
    • 第2項
    • 第3項

そして、サブセクションを非表示にして、TOCTree のみを保持し、必要な数と深さを維持したいと考えています。例えば:

  • ラベル
  • ラベル
  • 子供のラベル
    • 孫のラベル 1
    • 孫のレーベル2

ただし、Label of Childrenに関連付けられたハイパーリンクをクリックすると、通常どおりサブセクションが一覧表示されます。

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

python-sphinx - Sphinx globaltocサイドバーにすべてのドキュメントを含めるにはどうすればよいですか?

TOC全体のすべてのドキュメントをglobaltocサイドバーに含めたいと思います。どうすればこれを達成できますか?

テーマファイルには、への呼び出しがありますが、何を指して{{ toctree() }}いるのかわかりません。toctree()