1

Ich habe eine Webanwendung mit einigen "Hilfe" -Schaltflächen, die auf meine Online-Dokumentation zeigen. Die Links zu den Hilfeabschnitten sind in der App-Datenbank fest codiert. Zuvor wurde die Dokumentation in HTML und JS erstellt, und ich konnte die URLs für den Abschnitt manuell steuern.ReST/Sphinx - statische Alias ​​zu automatisch generierten Abschnitt URLs

Jetzt, da ich zu Sphinx und ReST migriere, fand ich die automatische Abschnitt URL-Generierung großartig, aber kann nicht herausfinden, wie dieses Verhalten für meine Struktur zu steuern.

Gibt es eine Möglichkeit, eine Art URL-Alias ​​zu haben, der auf die tatsächliche URL meiner Dokumentation verweist, um die fest codierten Links in der App db nicht jedes Mal zu aktualisieren, wenn ich den Namen meiner Kapitel/Sektionen aktualisiere?

Zum Beispiel:

  • Ich habe einen Unterabschnitt "Ich mag Äpfel" in Kapitel genannt 1.
  • Mein fest codierter Link, um es wäre so etwas wie "Chapter1 # I-like-Äpfel" zu sein (Ich interessiere mich nur für den Teil, der dem # Zeichen folgt)
  • ändere ich den Titel zu "ich hasse Äpfel". Der neue Link würde "Chapter1 # I-hate-apples" werden, aber in meinem db muss ich noch "# I-like-apples" haben, die auf denselben Abschnitt verweisen.

Antwort

3

Siehe Hyperlink Targets in der Dokutils-Dokumentation, speziell "interne Hyperlink-Ziele".

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

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

Sphinx generiert Ziele für jedes Synonym.

Sie können auch indirekte Hyperlinkziele verwenden.

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

My Subsection 
------------- 
Verwandte Themen