[PYTHON] Extension Sphinx pour convertir arbitrairement du texte en pré-traitement de la génération de documents

supposition

Récemment, j'écris un document avec Sphinx.

• Je veux écrire avec markdown de restructuredText
• Selon le document officiel, commonMark peut être utilisé, mais Table ne peut pas être utilisé
• "Une bonne bibliothèque!" ← [Introduction de M2R qui peut mélanger Markdown et reStructuredText dans un seul fichier (compatible avec l'extension Sphinx)](http://h-miyako.hatenablog.com/entry/2017/08/ 11/133620)

Je l'ai donc résolu une fois, mais lors de l'utilisation de PlantUML, il est devenu stressant de ne pas pouvoir prévisualiser sur VS Code.

Chose que tu veux faire

Lors de la création de HTML

```plantuml

Joindre

.. uml::

Je veux convertir automatiquement en.

#politique

Documentation officielleIl y a une méthode d'implémentation d'événement à l'intérieur.

• 「Sphinx.connect(event, callback)Il semble que la fonction de rappel de l'événement soit spécifiée avec. -Diverses définitions d'événements sont "Sphinx core eventsIl y a. -Si vous souhaitez convertir du texte brut comme cette fois,source-read(app, docname, source)Peut être utilisé.

#Implémentation du plug-in d'extension

Je l'ai écrit comme ça.

uml_change.py

def uml_change(app, docname, source):  
    umlFlg = False
    lines = []
    for line in source[0].split("\n"):
        if umlFlg:
            if line.strip() == "```":
                #Supprimer lorsque la fin de la boîte arrive
                line = ""
                umlFlg = False
            else:
                #Retrait à l'intérieur de la boîte
                line = "    " + line

        ###Convertir la notation markdown en notation reST
        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.paramètres py

conf.Ajoutez la description suivante à py.

conf.py

import sys
import os
 sys.path.append (os.path.abspath ("./ bin")) # Le nom du dossier est un exemple

Stockez le script ci-dessus dans le dossier spécifié (sous bin dans l'exemple ci-dessus).

Ajoutez le nom du plug créé aux extensions.

conf.py

extensions = ['uml_change']

Essayez de créer du html, et si l'image uml est affichée, elle réussit.

#Supplément

Vous devriez pouvoir écrire divers prétraitements en appliquant cette méthode. Convertir le format de lien de démarque en format restructuredText, etc.