Sphinxとは？
Python製のドキュメント作成特化型ライブラリ
Sphinxの特徴
- マイナー言語、Tex(数式)に対応
- ハイライト, 検索など便利機能
- PDF, ePubなど出力可能
- Pythonを知らなくても大丈夫！
- もちろんPythonが使えれば自分用に拡張カスタマイズ可能！
- Markdown記述
- 無料
Sphinxをインストールしてみる
Pythonがインストールされているのを前提とします。
今回はLinux上での構築例。
今回はLinux上での構築例。
pipをインストール
|
1 2 | yum -y install python-setuptools easy_install pip |
sphinxをインストール
|
1 | pip install Sphinx |
Sphinxのプロジェクトを生成してみる
|
1 2 | cd /var/www/html/ sphinx-quickstart |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | Welcome to the Sphinx 1.3.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 [.]: /var/www/html/sphinx 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: sample > Author name(s): Masanao Ohba 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]: 1.0.0 If the documents are to be written in a language other than English, you can select a language here by its language code. Sphinx will then translate text that it generates into that language. For a list of supported codes, see http://sphinx-doc.org/config.html#confval-language. > Project language [en]: jp 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]: y Please indicate if you want to use one of the following Sphinx extensions: > autodoc: automatically insert docstrings from modules (y/n) [n]: y > doctest: automatically test code snippets in doctest blocks (y/n) [n]: y > intersphinx: link between Sphinx documentation of different projects (y/n) [n]: y > todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: y > coverage: checks for documentation coverage (y/n) [n]: y > pngmath: include math, rendered as PNG images (y/n) [n]: y > mathjax: include math, rendered in the browser by MathJax (y/n) [n]: y Note: pngmath and mathjax cannot be enabled at the same time. pngmath has been deselected. > ifconfig: conditional inclusion of content based on config values (y/n) [n]: y > viewcode: include links to the source code of documented Python objects (y/n) [n]: y 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]: y > Create Windows command file? (y/n) [y]: n Creating file /var/www/html/sphinx/source/conf.py. Creating file /var/www/html/sphinx/source/index.rst. Creating file /var/www/html/sphinx/Makefile. Finished: An initial directory structure has been created. You should now populate your master file /var/www/html/sphinx/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. |
これでプロジェクトが自動生成されました。
source : 出力するための元となるコード
build : 出力されるhtml群などがここに入る
ではビルドしてみましょう。
|
1 | sphinx-build -b html source build |
これだけです。
/var/www/html/{{ プロジェクト名 }}/build/ をApacheでルートに設定して再起動！
こんな感じの初期表示がされます。
HTMLのような面倒なタグ入力も要らずにコードや見出しも記述出来ます。
今回は時間がなかったためインストール手順までの内容となりました。
