私のsome.rst
ファイルが次のようになっているとしましょう:
============
My Title
============
1. Section
================
2. Section
=================
コンパイル後、結果として、some.html
次のように表示される目次がサイドバーに表示されます。
私のタイトル
- セクション
- セクション
の目次に「マイタイトル」を削除する簡単な方法はありsome.html
ますか?
私のsome.rst
ファイルが次のようになっているとしましょう:
============
My Title
============
1. Section
================
2. Section
=================
コンパイル後、結果として、some.html
次のように表示される目次がサイドバーに表示されます。
私のタイトル
- セクション
- セクション
の目次に「マイタイトル」を削除する簡単な方法はありsome.html
ますか?
.. raw:: html
上記の方法を少し調整して(自動生成されたTOCを壊さないように)、これを解決することができました。前に説明したように、ファイルに.. raw:: html
見出しのみが含まれている場合、Sphinxの自動生成された目次が壊れます。ただし、使用してその下に.. raw:: html
追加---------------------
すると、左側のナビゲーションに表示されず、目次が壊れることはありません。例えば
それで、私はついに、左側の目次に見出しが表示されないようにする方法を偶然に見つけました。ファイルに.. raw:: html
h2見出しのみが含まれている場合、(stackoverflowの記事で説明されているように)スフィンクスの自動生成された目次が壊れます。ただし、その下を使用する.. raw:: html
と---------------------
、左側のナビゲーションには表示されず、目次:star2:egを壊すことはありません。
.. raw:: html
<h2>What Can I Do With KSQL?</h2>
---------------------
簡単な方法は、TOCディレクティブによって無視されるオブジェクトタイプを使用することです。
.. rubric:: My Title
これにより、見出しのように見えるテキストが作成されますが、目次から除外されます。CSSファイルは、クラスに必要なスタイルで更新できます。必要に応じて、.rubric
h1スタイルを模倣することもできます。
ルーブリックスタイルのクラスを定義する方法については、「Restructuredtextページ内の非TOC見出し」を参照してください。
すべてのドキュメントから削除しようとしている場合は、デフォルトのテンプレートをカスタマイズしてみてください。それ以外の場合は、サブクラスを作成してHTMLビルダーを変更する必要があります。
このパーティーに非常に遅れて、私は知っています。この問題が発生し、h2を模倣する必要があり、スタイルシートを編集できませんでした。
some.rst
私の解決策は、 :に生のhtmlを追加することでした。
:raw-html:`<h1>My Title</h1>`
1. Section
================
2. Section
=================
独自のh3タグを作成できます。
ヘッダーには次のものを使用します。
|start-h3| My title |end-h3|
後であなたが書くファイルの終わりに:
.. |start-h3| raw:: html
<h3>
.. |end-h3| raw:: html
</h3>
ローカルTOC(「このページの」TOC)について話しているようです。残念ながら、Sphinxは常にドキュメントタイトルを最初のアイテムとして印刷します(<li>
)。実際のローカルTOC(セクションタイトル)はすべて<ul>
、最初のドキュメントタイトル内にネストされています<li>
。(はい、それは迷惑です。)
2つのオプションがあります。
現在のSphinxテーマにローカルTOCがある場合は、生成されたHTMLマークアップを微調整する必要があります。たとえば、CSSを使用してドキュメントのタイトルを非表示にします。https://techwriter.documatt.com/2021/sphinx-localtoc-remove-document-title.htmlからのコピー貼り付け:
.localtoc > ul {
margin: 0;
}
.localtoc > ul > li {
list-style-type: none;
}
.localtoc > ul > li > a {
display: none;
}
.localtoc > ul > li > ul {
// any additional styles to local toc <ul>
}
別の方法として、ローカルTOCを手動で印刷contents::
することもできます。たとえば、ディレクティブとその:local:
オプションを使用してドキュメントの先頭に印刷します。https://restructuredtext.documatt.com/element/contents.html#no-current-document-titleからの例:
#################################
Contents without a document title
#################################
Testing ``contents::`` directive with ``:local:`` flag.
.. contents::
:local:
**********
Section L2
**********
Section L3
==========