.. _index:

==========================
PubliForge's documentation
==========================

`PubliForge` is a `Pyramid <http://www.pylonsproject.org>`_ Web site and Web
service application. It was originally developed by `iinov` team. It is
licensed under the the terms of the `GNU General Public License
<http://www.gnu.org/licenses/gpl.html>`_.

`PubliForge` is `PEP8 <http://www.python.org/dev/peps/pep-0008>`_ compliant and
`pylint <http://www.logilab.org/project/pylint>`_ checked.

.. and ships with 100% test coverage.

You can download the latest stable release at
http://pypi.python.org/pypi/PubliForge.

You can visit demonstration site at http://demo.publiforge.org (user: demo,
password: demo-password).

**Latest version:** |release|

------------
Installation
------------

How to install `PubliForge` in production mode along with development mode.

.. toctree::
   :maxdepth: 2

   Installation/deployment
   Installation/deployment_apache
   Installation/deployment_nginx
   Installation/customization
   Installation/development
   Installation/mercurial
   Installation/doc_generation

.. --------
.. Tutorial
.. --------

.. Detailed tutorial explaining how to use `PubliForge`.

.. .. toctree::
..    :maxdepth: 2

..    Tutorial/introduction

---------
Extension
---------

How to generate a set of configuration files for `PubliForge` or to create a
new processor.

.. toctree::
   :maxdepth: 2

   Extension/scaffolds

--------------------
Front Web User Guide
--------------------

A guide to work with the Web interface.

.. toctree::
   :maxdepth: 2

   FrontGuide/interface
   FrontGuide/storages
   FrontGuide/projects
   FrontGuide/administration
   FrontGuide/scripts

----------------
Agent User Guide
----------------

A guide to use agent with command-line scripts and to know how to configure a
resource for a processing.

.. toctree::
   :maxdepth: 2

   AgentGuide/modules
   AgentGuide/processors
   AgentGuide/scripts

-------------------
Front Web Reference
-------------------

Front web reference includes documentation for every `PubliForge` front
API.

.. toctree::
   :maxdepth: 2

   FrontReference/scripts
   FrontReference/initialization
   FrontReference/views
   FrontReference/models
   FrontReference/library
   FrontReference/permissions
   FrontReference/session
   FrontReference/cookies

---------------
Agent Reference
---------------

Agent reference includes documentation for every `PubliForge` agent API.

.. toctree::
   :maxdepth: 3

   AgentReference/scripts
   AgentReference/library
   AgentReference/xml-rpc

------------------
Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. todolist::