如何創建將不會出現在與獅身人面像toctree中的標題

我正在使用sphinx爲python模塊創建文檔。如何創建將不會出現在與獅身人面像toctree中的標題

我想在頁面上添加字幕，但我不希望它們出現在toctree。

我想要小節和簡短的幾行描述。將每個部分的標題添加到toctree將使瀏覽文檔變得更加困難。

這裏是我的index.rst：

Welcome to ModernGL's documentation! 
==================================== 

.. figure:: Examples/images/02_uniforms_and_attributes.png 
    :scale: 50 % 
    :alt: ModernGL 
    :align: center 
    :figclass: align-center 

Start `here <ModernGL.html>`_. 

.. toctree:: 
    :maxdepth: 4 
    :caption: Contents: 

    ModernGL <ModernGL.rst> 
    Examples <Examples.rst> 
    Contributing <Contributing.rst> 


Indices and tables 
================== 

* :ref:`genindex` 
* :ref:`modindex` 
* :ref:`search`

我想添加一些字幕：

Subtitle 1 
********** 

Subtitle 2 
********** 

Subtitle 3 
********** 

Subtitle 4 
**********

我檢查的文件，我不知道我應該使用什麼類型的下劃線。不知道是否有一個特殊的下劃線，這將是標題轉換爲<h4>或<h5>

隨着GitHub的README.md加入更多#字符會導致較小的標題。 * .rst是什麼？

構建文檔可以找到here，它不包含字幕，因爲它會破壞當前的文檔結構。

來源

2017-06-01 Szabolcs Dombi

你可以考慮使用[Rubric]（http://docutils.sourceforge.net/docs/ref/rst/directives.html#rubric）指令。 –

是的，rubric比'^^^^'強調更好：下面是一個例子：[rst file]（https://raw.githubusercontent.com/cprogrammer1994/ModernGL/master/docs/ModernGL.rst）和[css文件]（https://github.com/cprogrammer1994/ModernGL/blob/master/docs/static/css/custom.css#L25） –

您是否嘗試在toctree指令中添加hidden？喜歡的東西：

.. toctree:: 
    :maxdepth: 4 
    :hidden: 
    :caption: Contents: 

    ModernGL <ModernGL.rst> 
    Examples <Examples.rst> 
    Contributing <Contributing.rst>

這仍然會通知獅身人面像文檔層次的，而不是鏈接插入到在指示位置的文件 - 這是有道理的，如果你打算自己插入這些鏈接，在不同的風格，或者在HTML側邊欄中。

至於「節標題」（標題和小標題）從official Sphinx documentation這種提取物可能會給你一個答案：

通常情況下，有分配給特定的字符沒有標題級別的結構由下式確定標題的繼承。

您可能會嘗試使用^字符爲您的子部分渲染出您需要的標題。

來源

2017-06-01 14:57:12 errata

我需要其他文件出現在toctree。 _我想要3，只有那些出現在code_ –

我更新了我的答案...我希望我明白你想達到什麼:) – errata

我用'^^^^^^^^'爲下劃線（I找到你鏈接的文檔）。請編輯我接受的答案，因爲您鏈接了正確的文檔。 –

如何創建將不會出現在與獅身人面像toctree中的標題

回答

相關問題