[PYTHON] Sphinx-Erweiterung zur willkürlichen Konvertierung von Text in der Vorverarbeitung der Dokumentgenerierung

Annahme

Kürzlich schreibe ich ein Dokument mit Sphinx.

• Ich möchte mit Markdown von restructuredText schreiben
• Laut offiziellem Dokument kann commonMark verwendet werden, Table jedoch nicht
• "Eine gute Bibliothek!" ← [Einführung von M2R, mit der Markdown und reStructuredText in einer einzigen Datei gemischt werden können (Sphinx-Erweiterungskompatibel)](http://h-miyako.hatenablog.com/entry/2017/08/ 11/133620)

Also habe ich es einmal gelöst, aber bei der Verwendung von PlantUML wurde es stressig, dass ich keine Vorschau auf VS Code sehen konnte.

Was du machen willst

Bei der Erstellung von HTML

```plantuml

Umschließen

.. uml::

Ich möchte automatisch konvertieren zu.

#Politik

Offizielle DokumentationEs gibt eine Ereignisimplementierungsmethode.

• 「Sphinx.connect(event, callback)Es scheint, dass die Rückruffunktion für das Ereignis mit angegeben ist. -Verschiedene Ereignisdefinitionen sind "Sphinx core eventsEs gibt. -Wenn Sie wie dieses Mal einfachen Text konvertieren möchten,source-read(app, docname, source)Kann verwendet werden.

#Implementierung des Erweiterungs-Plug-Ins

Ich habe es so geschrieben.

uml_change.py

def uml_change(app, docname, source):  
    umlFlg = False
    lines = []
    for line in source[0].split("\n"):
        if umlFlg:
            if line.strip() == "```":
                #Löschen, wenn das Ende der Box kommt
                line = ""
                umlFlg = False
            else:
                #Einzug in die Box
                line = "    " + line

        ###Konvertieren Sie die Markdown-Notation in die reST-Notation
        if line.strip() == "```plantuml":
            line = ".. uml::"
            umlFlg = True
           
        lines.append(line)

    source[0] = "\n".join(lines)
  
def setup(app):  
    app.connect("source-read", uml_change)  

conf.py Einstellungen

conf.Fügen Sie py die folgende Beschreibung hinzu.

conf.py

import sys
import os
 sys.path.append (os.path.abspath ("./ bin")) # Der Ordnername ist ein Beispiel

Speichern Sie das obige Skript im angegebenen Ordner (im obigen Beispiel unter bin).

Fügen Sie den erstellten Plug-Namen zu Erweiterungen hinzu.

conf.py

extensions = ['uml_change']

Versuchen Sie, HTML zu erstellen, und wenn das Uml-Bild angezeigt wird, ist es erfolgreich.

#Ergänzung

Mit dieser Methode sollten Sie in der Lage sein, verschiedene Vorverarbeitungen zu schreiben. Konvertieren Sie das Markdown-Link-Format in das restructuredText-Format usw.