Pyterate is a Sphinx add-ons to generate API documentation using autogen and litterate programming documentation for Python projects.
Project description
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file Pyterate-2.1.5.tar.gz.
File metadata
- Download URL: Pyterate-2.1.5.tar.gz
- Upload date:
- Size: 557.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.8.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f23e3ccc16f2c09965b19e78bd2f83575f2f7026b14f8add6c00c8e9c2dbeb9 |
|
| MD5 | d20ffa0bb8fb3cc2126d6a18ccec280d |
|
| BLAKE2b-256 | 8cadeb0f968b53ef0be7f93ef34ebf844d6ed2a2ac35ea1fefb31be0bd7a18a7 |
File details
Details for the file Pyterate-2.1.5-py2.py3-none-any.whl.
File metadata
- Download URL: Pyterate-2.1.5-py2.py3-none-any.whl
- Upload date:
- Size: 68.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.8.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a2be40acf958ab8a407dda96598fa03bfdbe4009580bddc7ecf19d2fa88b5143 |
|
| MD5 | 206133fc821bb0f45eb580c6c9c14047 |
|
| BLAKE2b-256 | 2fff27c375fb01b47fd176491f5d68e95c4bdba36653442bc5c4ced546bf711c |
