Wie man einen Titel erstellt, der nicht im Token mit Sphinx erscheint

Ich benutze sphinx, um Dokumentation für ein Python-Modul zu erstellen.Wie man einen Titel erstellt, der nicht im Token mit Sphinx erscheint

Ich möchte gerne Untertitel auf einer Seite hinzufügen, aber ich möchte nicht, dass sie in der toctree erscheinen.

Ich möchte kleine Abschnitte und kurze (wenige Zeilen) Beschreibungen. Das Hinzufügen eines Abschnittstitels zu toctree würde das Durchsuchen der Dokumente erheblich erschweren.

Hier ist meine 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`

ich einige Untertitel hinzufügen möchten:

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

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

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

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

ich die Dokumentation überprüft und ich habe keine Ahnung, welche Art von unterstreichen sollte ich . Nicht sicher, ob es eine spezielle unterstrichen ist, dass der Titel sein umwandeln zu einem <h4> oder <h5>

Mit einem Github README.md mehr # Zeichen hinzugefügt wird in kleineren Titeln führen. Was ist das Äquivalent in * .rst?

Die Build-Dokumentation kann here gefunden werden und es enthält keine Untertitel, da es die aktuelle Struktur der Dokumente ruinieren würde.

Quelle

2017-06-01 Szabolcs Dombi

Sie könnten die Richtlinie [Rubrik] (http://docutils.sourceforge.net/docs/ref/rst/directives.html#rubric) verwenden. –

Ja Rubrik ist besser als die '^^^^ Unterstreichung: Hier ist ein Beispiel: [erste Datei] (https://raw.githubusercontent.com/cprogrammer1994/ModernGL/master/docs/ModernGL.rst) und [CSS Datei] (https://github.com/cprogrammer1994/ModernGL/blob/master/docs/static/css/custom.css#L25) –

Haben Sie versucht, hidden in Ihrer toctree-Anweisung hinzuzufügen? Etwas wie:

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

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

Dies wird noch Sphinx der Dokumenthierarchie benachrichtigen, aber nicht einfügen Links in das Dokument an der Stelle der Richtlinie - das macht Sinn, wenn Sie beabsichtigen, sich diese Links einzufügen, in a anderen Stil oder in der HTML-Sidebar.

Wie bei „Abschnittsüberschriften“ (Titel und Untertitel) dieser Extrakt aus official Sphinx documentation könnten Sie eine Antwort geben:

Normalerweise gibt es keine Überschriftsebenen bestimmten Zeichen zugeordnet, wie die Struktur aus bestimmt wird, die Reihenfolge der Überschriften.

Sie könnten versuchen, ^ Zeichen für Ihre Unterabschnitte zu verwenden, um die Überschrift, die Sie benötigen, auszugeben.

Quelle

2017-06-01 14:57:12 errata

Ich brauche andere Dokumente, die in Toctree erscheinen. _Ich will genau 3, nur die, die in der code_ –

erscheinen Ich aktualisierte meine Antwort ... Ich hoffe, ich habe verstanden, was Sie erreichen wollen :) – errata

Ich verwendete '^^^^^^^' für die Unterstreichung (I gefunden in den Dokumenten, die du verlinkt hast).Bitte bearbeiten Sie die Antwort, die ich akzeptiere, da Sie die entsprechenden Dokumente verknüpft haben. –

Wie man einen Titel erstellt, der nicht im Token mit Sphinx erscheint

Antwort

Verwandte Themen