環境
- Debian 8.5 最小構成インストール
- sudo, vim, ssh はインストール済み
目標
Sphinx でドキュメントを作成し、生成した html を Nginx で公開する。
作業
下記手順で作業を行う。
- 必要パッケージのインストール
- sphinx プロジェクトの作成
- ドキュメント作成
- ドキュメントビルド
- html を配置
必要パッケージのインストール
make が必要なの注意。
sudo apt install python3-sphinx
sudo apt install nginx
sudo apt install makesphinx プロジェクトの作成
Separate source and build directories は y のほうが管理しやすい感じがした。 その他はよしなにする感じで。
mikoto@debian-base:~$ mkdir -p sphinx/test
mikoto@debian-base:~$ cd sphinx/test/
mikoto@debian-base:~/sphinx/test$ sphinx-quickstart
Welcome to the Sphinx 1.2.3 quickstart utility.
Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).
Enter the root path for documentation.
> Root path for the documentation [.]:
You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: y
Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:
The project name will occur in several places in the built documentation.
> Project name: Test
> Author name(s): Mikoto2000
Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1. If you don't need this dual structure,
just set both to the same value.
> Project version: 1.0.0
> Project release [1.0.0]:
The file name suffix for source files. Commonly, this is either ".txt"
or ".rst". Only files with this suffix are considered documents.
> Source file suffix [.rst]:
One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:
Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]:
Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/n) [n]:
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> pngmath: include math, rendered as PNG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]:
A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (y/n) [y]:
> Create Windows command file? (y/n) [y]: n
Creating file ./source/conf.py.
Creating file ./source/index.rst.
Creating file ./Makefile.
Finished: An initial directory structure has been created.
You should now populate your master file ./source/index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.こんな感じのディレクトリ構成になります。
mikoto@debian-base:~/sphinx/test$ find ./ -maxdepth 2
./
./build
./Makefile
./source
./source/conf.py
./source/index.rst
./source/_templates
./source/_staticドキュメント作成
適当にドキュメントを作ります。
今回は、test.rst を作成して、 index.rst の toctree に test.rst を追加。
mikoto@debian-base:~/sphinx/test$ cat source/test.rst
====
test
====
Hello Sphinx document!
mikoto@debian-base:~/sphinx/test$ cat source/index.rst
.. Test documentation master file, created by
sphinx-quickstart on Tue Oct 18 23:52:34 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Test's documentation!
================================
Contents:
.. toctree::
:maxdepth: 2
test
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`ドキュメントビルド
プロジェクトルートで make html するだけ。
mikoto@debian-base:~/sphinx/test$ make html
sphinx-build -b html -d build/doctrees source build/html
Making output directory...
Running Sphinx v1.2.3
loading pickled environment... failed: [Errno 2] No such file or directory: '/home/mikoto/sphinx/test/build/doctrees/environment.pickle'
building [html]: targets for 2 source files that are out of date
updating environment: 2 added, 0 changed, 0 removed
reading sources... [100%] test looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] test writing additional files... genindex search
copying static files... done
copying extra files... done
dumping search index... done
dumping object inventory... done
build succeeded.build/html に html ファイルが生成される。
html を配置
生成された heml ファイルをそのまま nginx のドキュメントルートに突っ込んでしまえば OK。
mikoto@debian-base:~/sphinx/test$ sudo cp -r build/html/* /var/www/html/これで、 http://ホスト名/ にアクセスすると、生成した Sphinx ドキュメントが参照できるようになっているはず。
以上。
0 件のコメント:
コメントを投稿