.. $Id: index.rst 1545 2010-09-17 18:53:16Z bverheg $  -*- rst -*-
.. pyformex documentation master file

.. include:: <isonum.txt>
.. include:: defines.inc
.. include:: links.inc

######################
pyFormex Documentation
######################

This is the pyFormex |release| documentation, last updated on |today|.

.. warning:: We have moved to a new documentation management system
   (`Sphinx`_) and are currently in the process of rewriting the
   documentation. This means that some of these documents are in a
   rather unstable condition and may evolve quickly. The :doc:`intro`,
   :doc:`install`, :doc:`tutorial` and :doc:`refman` are already fairly
   complete and useable. The :doc:`user-guide` and :doc:`examples` are
   still in an embryonal state but may already contain valuable information
   for some users.


These documents are to become a full documentation set for the
installation and use of the pyFormex software. However, as pyFormex is
still under active development, so is this documentation: it therefore
is by no means final and complete; it does not even pretend to be
accurate for any version of pyFormex.

However, since partial documentation is better than none, we decided
to make this preliminary version available to the general public, to
ease the use of pyFormex. The :doc:`refman` is automatically generated
from the docstrings in the Python source, so that might best reflect
the latest development version of the software.

The new documentation is available in HTML format for interactive
browsing. A `PDF version`_ of the full documentation set can be downloaded
from our FTP server.


**Parts of the documentation**

.. toctree::
   :maxdepth: 1

   intro
   install
   tutorial
   user-guide
   examples
   refman
   file_format
   bumpix
   license
   meta


**Indices and tables**

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

.. End
