.. -*- Mode: rst -*-

.. include:: project-links.txt
.. include:: abbreviation.txt

==========
 Pyterate
==========

|Pypi License|
|Pypi Python Version|

|Pypi Version|

* Quick Link to `Production Branch <https://github.com/FabriceSalvaire/Pyterate/tree/master>`_
* Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/Pyterate/tree/devel>`_

Overview
========

What is Pyterate ?
--------------------

Pyterate is open source |Sphinx|_ add-ons which provide two tools for |Python|_ projects.  The
first one generates automatically the RST files for an API documentation based on the *autogen*
extension.  The second one provides a document generator based on the concept of literate
programming which can be used to make an example's based documentation.

Where is the Documentation ?
----------------------------

The documentation is available on the |PyterateHomePage|_.

What are the main features ?
----------------------------

The documentation generator features:

  * intermixing of code, text, `LaTeX formulae <https://www.mathjax.org>`_, figures and plots
  * use the `reStructuredText <https://en.wikipedia.org/wiki/ReStructuredText>`_ or `Markdown
    <https://en.wikipedia.org/wiki/Markdown>`_ syntax for text
  * use the |Sphinx|_ generator
  * embed computations in the text content
  * generation of circuit schematics using |Circuit_macros|_
  * generation of figures using |Tikz|_
  * generation of plots using |Matplotlib|_

How to install it ?
-------------------

Look at the `installation <https://fabricesalvaire.github.io/Pyterate/installation.html>`_ section in the documentation.

Credits
=======

Authors: `Fabrice Salvaire <http://fabrice-salvaire.fr>`_

News
====

.. include:: news.txt

.. End
