1

J'ai une application web avec des boutons "Aide" qui pointent vers ma documentation en ligne. Les liens vers les sections d'aide sont codés en dur dans la base de données d'applications. Auparavant, la documentation était faite en HTML et JS, et je pouvais contrôler les URL de la section manuellement. Cependant, maintenant que je migre vers Sphinx et ReST, j'ai trouvé la génération automatique d'URL de section géniale, mais je n'arrive pas à comprendre comment contrôler ce comportement pour ma structure.ReST/Sphinx - alias statique pour les URL de sections générées automatiquement

Y a-t-il un moyen d'avoir un alias d'URL qui pointe vers l'URL de ma documentation afin de ne pas mettre à jour les liens codés dans l'application chaque fois que je mets à jour le nom de mes chapitres/sections?

Par exemple:

  • J'ai un paragraphe appelé "J'aime les pommes" au chapitre 1.
  • Mon lien hardcoded à ce serait quelque chose comme "# I-Chapter1 comme des pommes" (Je me soucie seulement de la partie qui suit le signe # )
  • Je change le titre en "Je déteste les pommes". Le nouveau lien deviendrait "Chapter1 # I-hate-pommes", mais dans mon db je dois encore avoir "# I-like-pommes" qui pointent vers la même section.

Répondre

3

Voir Hyperlink Targets dans la documentation de docutils, en particulier les "cibles d'hyperliens internes".

.. _my-target: 
.. _synonym-to-my-target: 

My Subsection 
------------- 

Sphinx génèrera des cibles pour chaque synonyme.

Vous pouvez également faire des cibles d'hyperliens indirects.

.. _my-target: synonym-to-my-target_ 
.. _synonym-to-my-target: 

My Subsection 
-------------