2017-01-31 3 views
2

Ich mache eine Reihe von Design-Dokumenten in Sphinx und ich möchte sie zusammen in eine toctree einschließen und die Abschnitte innerhalb der Dokumente nummeriert haben. Ich weiß, dass ich .. sectnum:: verwenden kann, um alle Abschnitte in den untergeordneten Seiten zu nummerieren. Sphinx/rst Zahlen jedoch der Titel der Seite (das ist wirklich nur der erste Abschnitt) und das Inhaltsverzeichnis enden aussehen wie:Kann Sphinx Abschnittsnummerierung bestimmte Abschnitte überspringen (wie ein Titel)?

Table of Contents 
    1 Design the First 
    2 Design the Second 

und jedes Kind Seite wie folgt aussieht:

1 Design the First 
1.1 First Section 
1.2 Second Section 

Was ich will, ist ein Inhaltsverzeichnis auf meiner Index-Seite, dass der Titel nur listet

Table of Contents 
    Design The First 
    Design the Second 

und Kind-Seite, die wie

aussehen
Design the First 
1 First Section 
2 Second Section 

Gibt es eine Möglichkeit, einen Titel anzuzeigen, der sowohl im Inhaltsverzeichnis als auch oben auf einer untergeordneten Seite angezeigt wird, die jedoch kein nummerierter Abschnitt ist?

Antwort

0

Ich weiß nicht, was Sie getan haben, aber ich wollte genau dasselbe tun! Ich hatte die folgende Konfiguration:

index.rst 

.. toctree:: 

    assignment 
    library_api 

ich nur die Zuordnung Teil wollte Zahlen haben, also entweder getrennt zwei toctree mit einem mit :numbered: oder am Anfang der Datei gesetzt getan haben könnte

.. sectnum:: 
    :start: 0 

Geben Sie natürlich das genaue Problem, das Sie erwähnen - mein Top-Level-Titel war Assignment Writeup, also das war 0 und alles darunter in Unterabschnitten war 0.x eg

Assignment Writeup 
================== 

First Task 
---------- 

Second Task 
----------- 

gibt

0. Assignment Writeup 
    0.1 First Task 
    0.2 Second Task 

wie sich herausstellt, gibt es eine einfache Hack Sie tun können. Es macht die Dinge modularer als wahrscheinlich gewünscht, aber "fügen Sie eine Schicht von Indirektion hinzu". Jetzt habe ich assignment.rst und assignment_writeup.rst. assignment.rst hat im Grunde nur einen Titel und eine toctree:

Assignment Writeup 
================== 

.. toctree:: 
    :maxdepth: 4 

    assignment_writeup 

dann alle Teilabschnitte nehmen und sie in assignment_writeup und „upcast“ ihre Schriftsebene setzen. Also nehme ich jetzt alle Unterabschnitte und mache sie zu Abschnitten, subsub und mache sie sub.

.. sectnum:: 
    :start: 0 

First Task 
========== 

^^^ === instead of --- now 

Second Task 
=========== 

und wir haben jetzt endlich

Assignment Writeup 
    0. First Task 
    1. Second Task 

Art von zweifelhafter, aber das war der einzige Weg, ich es erreichen könnte X0 Ich frage mich, was Sie tat dies und jetzt zwischen fragen? Hoffentlich wird das jemand sehen und eines Tages davon profitieren!

Hinweis: Dies hat unerwünschte Nebenwirkungen. Die Zuweisung Writeup erscheint auf einer eigenen Seite, mit nur Links zum indirekten Dokument.Nicht sicher, was schlimmer ist ehrlich ...

Verwandte Themen