Ausgabe von der Markdown-Datei in der .rst-Datei rendern

2

Ich verwende Sphinx für die Dokumentation eines Python-Projekts und hätte gerne den Inhalt einer vorhandenen .md -Datei in einer .rst -Datei. (Ich habe meine conf.py bereits eingerichtet, um Abschläge zuzulassen).

Zum Beispiel habe ich eine Datei namens tutorial.md . Ich habe auch eine .rst -Datei wie folgt:

%Vor%

Ich möchte einen Link zu tutorial.md wie folgt einfügen, so dass der Inhalt von tutorial.md beim Rendern in der Datei angezeigt wird. Dies kann mit folgendem erreicht werden:

%Vor%

Der resultierende Inhalt sieht jedoch schlecht aus, da der Markdown nicht als Markdown dargestellt wird.

Mir ist klar, dass ich dieses Problem vermeiden kann, indem ich die gesamte Dokumentation als .md schreibe, aber diese Übung hat mich mit folgender Frage zurückgelassen:

Ist es möglich, .md content render als Markdown, innerhalb einer .rst Datei zu haben?

    
Jared Wilber 30.08.2017, 18:07
quelle

1 Antwort

3

Probieren Sie M2R Sphinx-Erweiterung.

Ссылка

Nach der Installation von m2r und dem Ändern von conf.py ändern Sie einfach .. include in .. mdinclude .

%Vor%     
miyako 02.09.2017, 08:39
quelle