Sphinx は、ドキュメント作成言語として reStructuredText を使用する Python ベースのドキュメント生成プロジェクトですが、モジュールを通じて他の形式もサポートできます。 🎜 > (Sphinx マークアップ構造) [ http://www.pythondoc.com/sphinx/markup/ ]
Sphinx のインストール
pip install sphinx sphinx-autobuild
#创建目录cd /path/to/projectmkdir docs#sphinx工作目录基本配置cd docs#可以回车按默认配置来写sphinx-quickstart#quickstart 后生成的目录结构readthedocs│ make.bat│ Makefile├─build└─source │ conf.py │ index.rst ├─_static └─_templates# 默认会有一个index.rst,make html用来生成html页面make html
hello,world======================================
Contents:.. toctree:: :maxdepth: 2 hello
マークダウン記述をサポート
pip install recommonmark
from recommonmark.parser import CommonMarkParsersource_parsers = { '.md': CommonMarkParser,}source_suffix = ['.rst', '.md']
pip install sphinx_rtd_theme
import sphinx_rtd_themehtml_theme = "sphinx_rtd_theme"html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
sphinx-quickstart で生成されたプロジェクトを github にプッシュします、gitignore で