Read the Docs > 入門してみた > sphinx-quickstart生成テンプレートの公開まで | PDF版のドキュメント取得

動作環境

GeForce GTX 1070 (8GB)
ASRock Z170M Pro4S [Intel Z170chipset]
Ubuntu 16.04 LTS desktop amd64
TensorFlow v1.2.1
cuDNN v5.1 for Linux
CUDA v8.0
Python 3.5.2
IPython 6.0.0 -- An enhanced Interactive Python.
gcc (Ubuntu 5.4.0-6ubuntu1~16.04.4) 5.4.0 20160609
GNU bash, version 4.3.48(1)-release (x86_64-pc-linux-gnu)
scipy v0.19.1
geopandas v0.3.0
MATLAB R2017b (Home Edition)
ADDA v.1.3b6
gnustep-gui-runtime v0.24.0-3.1
sphinx-build 1.7.1

Read the Docsに入門してみた。

準備

参考: Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
by rcmdnkさん

情報感謝です。

Sphinxのセットアップのため以下を実行しました。

$ sudo pip install recommonmark
$ sudo pip install sphinx sphinx-autobuild
$ sudo pip install sphinx_rtd_theme

手順

1. Read the Docsにアカウント作成
2. GitHubにリポジトリ作成
   • ReadTheDocs_180310 @ GitHub
   • この時点でローカルにcloneがある
3. mkdir docs, cd docs
4. sphinx-quickstartにてSphinxのテンプレートを作成
5. docs/にて手順4生成ファイルをGitHubにpush
   • _build/はignore設定する
     • ../.gitignoreにdocs/_build/を記載
   • git add -A
   • git commit -m "add docs"
   • プッシュする
6. Read the Docsのプロジェクトを作成 (ReadTheDocs_180310)
   • https://readthedocs.org/projects/readthedocs-180310/
7. Read the Docsのプロジェクトをビルド
   • [概要]ページの[ビルド]ボタン
   • [トリガーされた...]をクリックして進捗を見る

   • "Build completed"（緑色）が表示されればビルド完了

ページ

(追記: 記事投稿後に内容を追加しています(show2dimage_180310の追加)。）。

PDF版のドキュメント取得

公開したドキュメントにはPDFとしての取得機能はない。

一方で以下には[ダウンロード]ページに「latest PDF」「latest HTMLZip」「latest Epub」の機能がある。
https://readthedocs.org/projects/readthedocs-180310/downloads/