Created
August 5, 2011 18:59
-
-
Save harikt/1128244 to your computer and use it in GitHub Desktop.
Running sphinx-quickstart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hari@hari-Vostro1510:/media/Linux/docs/docs$ 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: The Aura Project for PHP 5.3 | |
> Author name(s): Paul M Jones | |
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: 0.01 | |
> Project release [0.01]: | |
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]: | |
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. | |
hari@hari-Vostro1510:/media/Linux/docs/docs$ ls | |
_build conf.py index.rst make.bat Makefile _static _templates | |
hari@hari-Vostro1510:/media/Linux/docs/docs$ make html | |
sphinx-build -b html -d _build/doctrees . _build/html | |
Making output directory... | |
Running Sphinx v0.6.6 | |
loading pickled environment... not found | |
building [html]: targets for 1 source files that are out of date | |
updating environment: 1 added, 0 changed, 0 removed | |
reading sources... [100%] index | |
looking for now-outdated files... none found | |
pickling environment... done | |
checking consistency... 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. | |
Build finished. The HTML pages are in _build/html. | |
hari@hari-Vostro1510:/media/Linux/docs/docs$ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment