read-the-docshosted 研究ノート_html/css_WEB-ITnose

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.rst を作成します:

hello,world======================================

index.rst は次のように変更されます:

Contents:.. toctree::   :maxdepth: 2   hello

make html 後の効果は次のとおりです:

マークダウン記述をサポート

pip install recommonmark

conf.py:<🎜 を変更します。 >

from recommonmark.parser import CommonMarkParsersource_parsers = {    '.md': CommonMarkParser,}source_suffix = ['.rst', '.md']

テーマの変更 sphinx_rtd_theme

pip install sphinx_rtd_theme

conf.py の変更:

import sphinx_rtd_themehtml_theme = "sphinx_rtd_theme"html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

Github ホスティング、read_the_docs 公開

doc

sphinx-quickstart で生成されたプロジェクトを github にプッシュします、gitignore で

に設定でき、readthedocs にログインし、アカウントを登録し、Connected Services で github を認証します
ダッシュボードでプロジェクトをインポートし、github にプロジェクトをインポートします。

をビルドします。