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

WBOY
リリース: 2016-06-21 08:48:18
オリジナル
1579 人が閲覧しました

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 を認証します
  1. ダッシュボードでプロジェクトをインポートし、github にプロジェクトをインポートします。
をビルドします。
関連ラベル:
ソース:php.cn
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート
私たちについて 免責事項 Sitemap
PHP中国語ウェブサイト:福祉オンライン PHP トレーニング,PHP 学習者の迅速な成長を支援します!