2017-10-19 3 views
1

J'ai appris qu'il est possible de conserver ma documentation sous une forme modulaire avec des parties/chapitres, etc., sur plusieurs fichiers by using the include command.Comment conserver une structure de pièce/de chapitre dans Sphinx sans créer une seule page longue?

Le seul problème de cette approche est qu'elle concatène efficacement tous les fichiers inclus dans un gros fichier, ce qui signifie qu'ils ne sont plus traités comme des pages séparées par le Sphinx Read The Docs theme.

En conséquence, la documentation a très longues pages que les utilisateurs doivent faire défiler vers le bas, plutôt que des pages courtes avec previous/next boutons pour la navigation. Je voudrais que ma documentation ait cette dernière structure parce que je pense que cela crée une expérience utilisateur beaucoup plus confortable. Comment puis-je préserver la structure d'une pièce/d'un chapitre sans créer une page longue et longue?

+0

C'est ce que 'toctree' est pour. http://www.sphinx-doc.org/fr/stable/markup/toctree.html – mzjn

+0

Salut @mzjn, merci pour votre commentaire. J'ai lu la documentation sur 'toctree' et je sais comment l'utiliser, mais je ne suis pas sûr de savoir ce que vous voulez dire quand vous dites: 'C'est pour ça' toctree'. Seriez-vous en mesure d'élaborer votre commentaire dans une réponse complète? – AZD

+0

Je ne comprends pas quel est le problème. toctree peut être utilisé pour "préserver la structure de la pièce/du chapitre sans créer une seule page longue". – mzjn

Répondre

0

me Fonder sur la question plus tôt que vous faites référence, je vous mets en garde au sujet de la solution qui est donnée là ou plus encore au sujet de la question elle-même :-)

Votre document n'a pas reproduire les rubriques correctement ("partie "against" chapter ") car la directive toctree considère le premier titre du document inclus comme le" titre supérieur "de ce document. L'autre solution consistait à déplacer le

###### 
Part 1 
###### 

partie dans le fichier principal, celui avec la directive toctree.

###### 
Part 1 
###### 

.. toctree:: 
    :maxdepth: 2 

    test1 
    test2 

J'ai appris à ce sujet par l'expérience. Je ne peux pas trouver une référence appropriée à ce sujet, cependant.