Construire un Sphinx qui peut être écrit avec Markdown

Contexte

Sphinx est un système de documentation open source utilisé dans divers endroits, y compris diverses bibliothèques Python. Sphinx écrit des documents dans un langage de balisage léger appelé reStructuredText, mais maintenant il est plus populaire avec des services tels que GitHub et Qiita, et je suis habitué à Markdown [^ utilisabilité].

Par conséquent, je voudrais créer un environnement dans lequel vous pouvez écrire avec Markdown même avec Sphinx. Utilisez l'extension Sphinx appelée recommonmark.

procédure

On suppose que l'environnement python peut utiliser virtualenvwrapper.

Préparation environnementale

$ mkvirtualenv sphinx
$ pip install sphinx recommonmark

Génération de projet

$ sphinx-quickstart 

Réglage

Ajoutez la description suivante à conf.py.

from recommonmark.parser import CommonMarkParser

source_parsers = {
    '.md': CommonMarkParser,
}

source_suffix = ['.rst', '.md']

Après cela, si vous écrivez un document avec l'extension .md, il sera automatiquement compilé en tant que Markdown.

[^ Convivialité]: C'est juste une impression personnelle. .. ..

Recommended Posts

Construire un Sphinx qui peut être écrit avec Markdown
Fonctions pouvant être utilisées dans l'instruction for
Algorithmes de base utilisables par les pros de la compétition
Enregistrement d'image ANT qui peut être utilisé en 5 minutes
Goroutine (contrôle parallèle) utilisable sur le terrain
Analyse de texte pouvant être effectuée en 5 minutes [Word Cloud]
Goroutine utilisable sur le terrain (édition errgroup.Group)
Scripts pouvant être utilisés lors de l'utilisation de Bottle en Python
Index d'évaluation pouvant être spécifié pour GridSearchCV de sklearn
Confirmation que rkhunter peut être installé
Créez une Spinbox qui peut être affichée en binaire avec Tkinter
Un minuteur (ticker) qui peut être utilisé sur le terrain (peut être utilisé n'importe où)
Gestion des chaînes de caractères dans la communication JSON
Résumé de l'entrée standard de Python pouvant être utilisée dans Competition Pro
Créez une Spinbox pouvant être affichée dans HEX avec Tkinter
Remplissage facile des données pouvant être utilisées dans le traitement du langage naturel
Résumé des problèmes d'AtCoder C qui peuvent être résolus en mathématiques au secondaire
Bot LINE sans serveur qui peut être réalisé en 2 heures (acquisition de l'identifiant source)
Nombre maximum de paramètres de fonction pouvant être définis dans chaque langue
Une histoire que heroku, qui peut se faire en 5 minutes, a en fait duré 3 jours
Je souhaite créer une file d'attente prioritaire pouvant être mise à jour avec Python (2.7)
Notes personnelles des opérations liées aux pandas qui peuvent être utilisées dans la pratique
Programme d'installation facile et programme de mise à jour automatique pouvant être utilisé dans n'importe quelle langue
Cela peut être réalisé en 1 minute! Le décorateur qui met en cache l'exécution de la fonction entraîne Memcached
Types de fichiers pouvant être utilisés avec Go
Répertorier les packages pouvant être mis à jour avec pip
Résumé des méthodes d'analyse de données statistiques utilisant Python qui peuvent être utilisées en entreprise
Visualisation des informations géographiques de R et Python qui peuvent être exprimées par Power BI
Mettre en place un serveur FTP qui peut être créé et détruit immédiatement (en Python)
Analyse morphologique et tfidf (avec code de test) pouvant être effectuée en 1 minute environ
L'histoire selon laquelle sendmail qui peut être exécuté dans le terminal ne fonctionnait pas avec cron
Un mécanisme pour appeler des méthodes Ruby à partir de Python qui peut être fait en 200 lignes
Pour pouvoir utiliser le japonais avec Python dans l'environnement Docker
Quantité d'entités pouvant être extraite des données de séries chronologiques
Liste des couleurs pouvant être définies avec tkinter (mémorial)
Notes sur les connaissances Python utilisables avec AtCoder
Peut être utilisé chez les pros de la compétition! Bibliothèque standard Python
[Django] À propos des utilisateurs pouvant être utilisés sur un modèle
Les équations simultanées non linéaires peuvent être facilement résolues avec Python.
Cours de Deep Learning pouvant être écrasé sur place
Limites qui peuvent être analysées à la fois avec MeCab
Lister les classes qui peuvent être référencées par ObjCClass
Comment configurer un serveur SMTP simple qui peut être testé localement en Python
[Django] Noms de champs pouvant être utilisés pour le modèle utilisateur, l'enregistrement des utilisateurs et les méthodes de connexion
[Python3] Code qui peut être utilisé lorsque vous souhaitez redimensionner des images dossier par dossier