FabriceSalvaire / Pyterate

Pyterate is Sphinx add-ons to generate documentation for Python projects

Home Page:https://fabricesalvaire.github.io/Pyterate/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pyterate

Pyterate license Pyterate python version

Pyterate last version

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.

Comparison to other libraries

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.

Where is the Documentation ?

The documentation is available on the Pyterate Home Page.

What are the main features ?

The documentation generator features:

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

About

Pyterate is Sphinx add-ons to generate documentation for Python projects

https://fabricesalvaire.github.io/Pyterate/

License:GNU General Public License v3.0


Languages

Language:Python 96.4%Language:Jinja 1.5%Language:Emacs Lisp 1.4%Language:Shell 0.7%