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?
C'est ce que 'toctree' est pour. http://www.sphinx-doc.org/fr/stable/markup/toctree.html – mzjn
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
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