Sphinx ist ein Open-Source-Dokumentationssystem, das an verschiedenen Orten verwendet wird, einschließlich verschiedener Python-Bibliotheken. Sphinx schreibt Dokumente in einer leichtgewichtigen Markup-Sprache namens reStructuredText, aber jetzt ist es bei Diensten wie GitHub und Qiita beliebter, und ich bin an Markdown [^ Usability] gewöhnt.
Daher möchte ich eine Umgebung erstellen, in der Sie mit Markdown auch mit Sphinx schreiben können. Verwenden Sie die Sphinx-Erweiterung recommonmark.
Es wird davon ausgegangen, dass die Python-Umgebung virtualenvwrapper verwenden kann.
$ mkvirtualenv sphinx
$ pip install sphinx recommonmark
$ sphinx-quickstart
Fügen Sie conf.py die folgende Beschreibung hinzu.
from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
Wenn Sie danach ein Dokument mit der Erweiterung ".md" schreiben, wird es automatisch als Markdown kompiliert.
[^ Usability]: Es ist nur ein persönlicher Eindruck. .. ..
Recommended Posts