問題タブ [toctree]

「特別なエントリ名 self は、toctree ディレクティブを含むドキュメントを表します。これは、toctree から「サイトマップ」を生成する場合に役立ちます。」そして、私はこのスレッドを見てきました - Using self to create a sitemap with toctree in sphinx は壊れているようですか? . 私はこれを機能させることができないようです。

私が見ることができるスフィンクスによって生成されたサイトマップの詳細な例がある場所はありますか?

スフィンクス Web ページのキャプションの色を変更する方法はありますか? toctree:caption:でディレクティブを使用していますが、キャプションはサイドバーとほぼ同じ色になります。参考までに、キャプションが見にくいページへのリンクと、私のインデックス ファイルを次に示します。

ドキュメントを toctree に挿入すると、表示されるリンクはドキュメントのメイン タイトルになります。だから私がするとき：

私は得る：

材料

• 拡散素材
• 光沢のある素材
• 鏡面反射素材

「マテリアル」という言葉は、toctree では明らかに冗長ですが、ドキュメントのタイトルでは理解を深めるために重要です。

RST を使用すると、次のように記述できます。

しかし、ドキュメントの名前を変更するにはインデックスの toctree を更新する必要があり、リンクの更新が MediaWiki から Sphinx に移行した理由なので、私はこれが好きではありません。また、これにより、toctree での :glob: とワイルドカードの使用が無効になります

質問:たとえば「diffuse.rst」で、リーフ ドキュメント自体に toctree タイトルをメタ プロパティとして指定する方法はありますか?

ありがとう！

次のindex.rstファイルがあります。

サイドバーは次のようになります。

その画像で説明されているように。いくつかやりたいことがあります。

1. サイドバーのタイトルのみを削除し、メイン ページは維持します。
2. 新しい URL リンクを追加しますが、「インデックスとテーブル」などのメイン ページには表示されません。

どうやってやるの？

さまざまなフォルダーを含むディレクトリがあり、それぞれに matlab ソース ファイルが含まれています。これらのフォルダーの一部には、matlab ソース ファイルを含むサブフォルダーがあります。

Sphinx を使用して TOC ツリーを作成し、サブフォルダーをネストされた方法で含めるにはどうすればよいですか?

たとえば、次のフォルダ構造とともに、、およびMain-Directoryが含まれている場合:conf.pyindex.rstmoduleslist.rst

このindex.rstファイルで：

そしてこのmoduleslist.rstファイル：

ただし、これにはサブフォルダーFolder2.1とファイルは含まれません。のドキュメントが含まれていないのオートモジュールを含む を追加しようとしFolder2/indexました。index.rstFolder2/index.rstFolder2.1ghi.m

Sphinx の TOC ツリーにネストされたサブフォルダを表示するにはどうすればよいですか?

構造

プロジェクトの次の構造:

• index.rst

  /li>

• group1.rst

  /li>

レンダリング先 ( Group1->をクリックした後Subgroup2):

ご覧のとおり、Group1ページが開き、セクションにリンクされていSubgroup2ます。

欲しい

左側（Group1opennedとselected Subgroup2）に同じものを置きたいのですが、右側にはSubgroup2ページ（Subgroup1コンテンツのないページ）のみを表示したいです。

つまり、ファイルがありますgroup1/subgroup1.rst：

レンダリング先:

それはどのように達成できますか？これは深さ 2 の簡単な例ですが、深さ 3 ～ 4 はどうでしょうか。

私のドキュメント構造は次のようになります。

生成された構造は次のようになります。

foo と Zoo の両方の toctree は次のようになります。

2 つの異なる shared.html ファイルをコンパイルして、1 つはパンくずリストのようbreadcrumbs: home -> zoo -> sharedに、もう1 つはbreadcrumbs: home -> foo -> shared. これはスフィンクスで可能ですか？

参考までに、これはブレッドクラム生成用の私のテンプレート コードです。

ライブラリの 1 つでドキュメントを増やしたいと考えています。私はスフィンクスを使ってドキュメントを作成してきましたが、最近は autodoc 拡張機能の調査を開始しました。

ほとんどの専門的なドキュメントのように、各クラスのドキュメント ページには、ドキュメント化されたすべてのメソッドのリストが上部にリンク付きで表示されます。または、言い換えれば、より詳細なメソッド ドキュメントのそれぞれへのハイパーリンクを含むトップの toctree です。

autodoc で文書化されているクラスごとに、この toctree を自動的に作成する方法はありますか?

私のスフィンクスのドキュメントには、(もちろん) toctree の一部にする必要があるいくつかのマイナーなページがありますが、それらを適切な場所にリストすることができません。

「セクション 3」ページが次のようになっている場合:

次に3.3とが の前に3.4リストされます。 3

他の順列を試しましたが、どれもうまくいかないようです。

1. 3見出しの後に toctree を配置すると、3.3との間に3.4リストされます。 33.1
2. ページの最後に toctree を配置すると、すべてが正しい順序になりますが3.3、3.4section の子である第 3 レベルのセクションになります3.2。

ここに具体的な例を挙げました：

• http://sphinx-problem.readthedocs.org/en/latest/
• https://github.com/bukzor/sphinx-problem