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.
On suppose que l'environnement python peut utiliser virtualenvwrapper.
$ mkvirtualenv sphinx
$ pip install sphinx recommonmark
$ sphinx-quickstart
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