Oracle Linux 6.4 に Sphinx をインストールする

インストールする

# yum install python-sphinx

...

Dependencies Resolved

=======================================================================================================================================================================
 Package                                     Arch                               Version                                   Repository                              Size 
=======================================================================================================================================================================
Installing:                                                                                                                                                            
 python-sphinx                               noarch                             0.6.6-2.el6                               ol6_latest                             486 k 
Installing for dependencies:                                                                                                                                           
 python-babel                                noarch                             0.9.4-5.1.el6                             ol6_latest                             1.4 M 
 python-docutils                             noarch                             0.6-1.el6                                 ol6_latest                             1.3 M 
 python-jinja2                               x86_64                             2.2.1-1.el6                               ol6_latest                             464 k 
 python-pygments                             noarch                             1.1.1-1.el6                               ol6_latest                             561 k 

Transaction Summary
=======================================================================================================================================================================
Install       5 Package(s)

Total download size: 4.2 M
Installed size: 17 M
Is this ok [y/N]: y

...

Installed:
  python-sphinx.noarch 0:0.6.6-2.el6

Dependency Installed:
  python-babel.noarch 0:0.9.4-5.1.el6      python-docutils.noarch 0:0.6-1.el6      python-jinja2.x86_64 0:2.2.1-1.el6      python-pygments.noarch 0:1.1.1-1.el6

Complete!

プロジェクトを作成する

$ sphinx-quickstart
Welcome to the Sphinx 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]:                        

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: weekly_report                                            
> Author name(s): yazekats                                               

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
> Project release [1.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]:

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]:
> jsmath: include math, rendered in the browser by JSMath (y/N) [n]:
> ifconfig: conditional inclusion of content based on config values (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

Finished: An initial directory structure has been created.

You should now populate your master file ./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.

ドキュメントを作成する

  • rst から HTML を生成する
$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v0.6.6
loading pickled environment... done
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] 20131220-1230
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/yazekats/Documents/misc/sphinx/20131220-1230.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] index
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.

Build finished. The HTML pages are in _build/html.
$ cd _build/html                                                                                      
$ ls -l
total 32
-rw-rw-r-- 1 yazekats yazekats 3573 Dec 31 15:21 20131220-1230.html
-rw-rw-r-- 1 yazekats yazekats 2787 Dec 31 15:21 genindex.html
-rw-rw-r-- 1 yazekats yazekats 3971 Dec 31 15:21 index.html
-rw-rw-r-- 1 yazekats yazekats   69 Dec 31 15:21 objects.inv
-rw-rw-r-- 1 yazekats yazekats 2990 Dec 31 15:21 search.html
-rw-rw-r-- 1 yazekats yazekats  362 Dec 31 15:21 searchindex.js
drwxrwxr-x 2 yazekats yazekats 4096 Dec 31 15:19 _sources
drwxrwxr-x 2 yazekats yazekats 4096 Dec 31 15:19 _static

*1:自分向けメモ