Sphinx Docs

Maxime HORCHOLLE

C'est quoi

- Générateur de documentation statique multi-format

- Multi-format HTML / PDF / ePub / ...

- reStructuredText

- Utilisé par Symfony entre autre

Pourquoi

- Configurable

- Simple

- Versionnable

- Maintenable

Installation

$ sudo apt-get install python-setuptools
$ sudo easy_install -U Sphinx

Comment ça marche

.
|-- Makefile
|-- _exts
|   |-- httpdomain
|   `-- sphinx-php
|-- _static
|   |-- css
|   |-- img
|   `-- js
|-- _templates
|   |-- _quick_preview.html
|   |-- layout.html
|   |-- localtoc.html
|-- api
|   `-- general.rst
|-- conf.py
|-- index.rst

toctree

API
---
.. toctree::
    :hidden:
    
   api/general

Exemple

API Documentation
=================

General
-------

Authentication
~~~~~~~~~~~~~~

Authentication Query
````````````````````

*Sample* ``query`` **code**

Resultat

Configuration

Extension

Customisation