1. Overview¶

1.1. What is Pyterate ?¶

Pyterate is free and open source (*) Sphinx add-ons which provide two tools for Python projects. The first one provides a Sphinx source generator based on the concept of literate programming which can be used to make an example’s based documentation. The second one is a tool similar to sphinx-apidoc to generate automatically the Sphinx sources for an API documentation using the autodoc extension.

1.2. How is Pyterate licensed ?¶

Pyterate is licensed under the GPLv3.

1.3. Going further with Pyterate¶

The best way to know what you can do with Pyterate, and to learn it, is to look at the examples:

• Examples

• Pyterate Reference Manual

1.4. What are the features of the documentation generator ?¶

The documentation generator features:

Somehow, it is similar to an Jupyter notebook, but it works differently and provides specific features.

1.5. Which platforms are supported by Pyterate ?¶

Pyterate runs on Linux, Windows 64-bit and Mac OS X.

1.6. How to install Pyterate ?¶

The procedure to install Pyterate is described in the Installation Manual.

1.7. Which version of Python is required ?¶

Pyterate requires Python 3.