Criando documentação elegante com Sphinx

anderson@yoda:~/tmp$ sphinx-quickstart <br />Welcome to the Sphinx quickstart utility.<br /><br />Please enter values for the following settings (just press Enter to<br />accept a default value, if one is given in brackets).<br /><br />Enter the root path for documentation.<br />> Root path for the documentation [.]: <br /><br />You have two options for placing the build directory for Sphinx output.<br /><br />Either, you use a directory "_build" within the root path, or you separate<br />"source" and "build" directories within the root path.<br />> Separate source and build directories (y/N) [n]: y<br /><br />Inside the root directory, two more directories will be created; "_templates"<br />for custom HTML templates and "_static" for custom stylesheets and other static<br />files. You can enter another prefix (such as ".") to replace the underscore.<br />> Name prefix for templates and static dir [_]: <br /><br />The project name will occur in several places in the built documentation.<br />> Project name: Teste Sphinx  <br />> Author name(s): Christiano Anderson<br /><br />Sphinx has the notion of a "version" and a "release" for the<br />software. Each version can have multiple releases. For example, for<br />Python the version is something like 2.5 or 3.0, while the release is<br />something like 2.5.1 or 3.0a1.  If you don't need this dual structure,<br />just set both to the same value.<br />> Project version: 1.0<br />> Project release [1.0]: <br /><br />The file name suffix for source files. Commonly, this is either ".txt"<br />or ".rst".  Only files with this suffix are considered documents.<br />> Source file suffix [.rst]: <br /><br />One document is special in that it is considered the top node of the<br />"contents tree", that is, it is the root of the hierarchical structure<br />of the documents. Normally, this is "index", but if your "index"<br />document is a custom template, you can also set this to another filename.<br />> Name of your master document (without suffix) [index]: <br /><br />Please indicate if you want to use one of the following Sphinx extensions:<br />> autodoc: automatically insert docstrings from modules (y/N) [n]: <br />> doctest: automatically test code snippets in doctest blocks (y/N) [n]: <br />> intersphinx: link between Sphinx documentation of different projects (y/N) [n]: <br />> todo: write "todo" entries that can be shown or hidden on build (y/N) [n]: <br />> coverage: checks for documentation coverage (y/N) [n]: <br />> pngmath: include math, rendered as PNG images (y/N) [n]: <br />> jsmath: include math, rendered in the browser by JSMath (y/N) [n]: <br />> ifconfig: conditional inclusion of content based on config values (y/N) [n]: <br /><br />A Makefile and a Windows command file can be generated for you so that you<br />only have to run e.g. `make html' instead of invoking sphinx-build<br />directly.<br />> Create Makefile? (Y/n) [y]: <br />> Create Windows command file? (Y/n) [y]: n<br /><br />Finished: An initial directory structure has been created.<br /><br />You should now populate your master file ./source/index.rst and create other documentation<br />source files. Use the Makefile to build the docs, like so:<br />   make builder<br />where "builder" is one of the supported builders, e.g. html, latex or linkcheck

# The language for content autogenerated by Sphinx. Refer to documentation<br /># for a list of supported languages.<br />language = 'pt_BR'

Título<br />======<br /><br />A linguagem de marcação é semelhante a muitos wikis.<br /><br />Subtítulo<br />---------<br /><br />Você também pode usar **negrito**, *itálico*.<br /><br />Uma lista enumerada ficaria assim:<br /><br />   #. Primeira linha<br />   #. Segunda linha<br />   #. Terceira linha<br /><br />.. hint::<br />   Aqui você pode colocar uma dica 

.. Teste Sphinx documentation master file, created by<br />   sphinx-quickstart on Sun Oct 24 18:19:06 2010.<br />   You can adapt this file completely to your liking, but it should at least<br />   contain the root `toctree` directive.<br /><br />Welcome to Teste Sphinx's documentation!<br />========================================<br /><br />Contents:<br /><br />.. toctree::<br />   :maxdepth: 2<br /><br />   intro<br /><br />Indices and tables<br />==================<br /><br />* :ref:`genindex`<br />* :ref:`modindex`<br />* :ref:`search`