Skip to content
index.rst 1.08 KiB
Newer Older
Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. include:: project-links.txt

.. hack to move down the next note block
.. raw:: html

   <br/>

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Welcome to the Patro documentation!
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. note:: The official Home Page of Patro is located at |PatroUrl|
Fabrice Salvaire's avatar
Fabrice Salvaire committed

    If you are at http://readthedocs.org then you are reading the so called *latest documentation*.

Fabrice Salvaire's avatar
Fabrice Salvaire committed
    The *latest documentation* |Patro@readthedocs-badge| is automatically built from the
Fabrice Salvaire's avatar
Fabrice Salvaire committed
    git repository after each commit.

Fabrice Salvaire's avatar
Fabrice Salvaire committed
    As opposite the |PatroHomePage|_ is built manually and is thus less prone to errors.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. include:: introduction.txt

.. include:: features.txt

Fabrice Salvaire's avatar
Fabrice Salvaire committed
==============
 Installation
==============

Fabrice Salvaire's avatar
Fabrice Salvaire committed
The procedure to install Patro is described in the :ref:`Installation Manual <installation-page>`.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

===============
 Documentation
===============

Fabrice Salvaire's avatar
Fabrice Salvaire committed
The best way to know what we can do with Patro and learn it, is to start with the examples.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
 * :ref:`Patro Reference Manual <reference-manual-page>`
Fabrice Salvaire's avatar
Fabrice Salvaire committed
 * :ref:`Bibliography <bibliography-page>`
Fabrice Salvaire's avatar
Fabrice Salvaire committed

==========
 Overview
==========

.. toctree::
  :maxdepth: 3
  :numbered:

  installation.rst
  reference-manual.rst
Fabrice Salvaire's avatar
Fabrice Salvaire committed
  bibliography.rst
Fabrice Salvaire's avatar
Fabrice Salvaire committed

.. End