• Quick Link to Production Branch
• Quick Link to Devel Branch

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.

Jupyter Book does a similar job than Pyterate. The main differences are:

• Jupyter Book is code cells in Markdown, while Pyterate is text cells in Python.
• Jupyter Book exploits the recent Markdown support of Sphinx, thanks to MyST.
• Jupyter Book translates Markdown sources to Jupyter Notebooks and then execute them.
• Jupyter Book caches the executed notebooks.
• Jupyter Book use extensively the Sphinx API, while Pyterate just generates Rest sources, as well as Jupyter Notebooks.
• Pyterate uses a Jupyter kernel to execute the Python code.
• Pyterate can generate figures from external generators.

See also:

• Pweave is a scientific report generator and a literate programming tool for Python. It is not maintained since 2019.

The documentation is available on the Pyterate Home Page_.

The documentation generator features:

• intermixing of code, text, LaTeX formulae, figures and plots
• use the reStructuredText or 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_

Look at the installation section in the documentation.

Authors: Fabrice Salvaire

• new design

Extracted source from https://github.com/FabriceSalvaire/PySpice