Pyterate
- Quick Link to Production Branch
- Quick Link to Devel Branch
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 Pyterate Home Page.
What are the main features ?
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
How to install it ?
Look at the installation section in the documentation.
Credits
Authors: Fabrice Salvaire
News
V2 2017-11-28
- new design
V1 2017-11-10
Extracted source from https://github.com/FabriceSalvaire/PySpice