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.
(*) Pyterate is licensed under GPLv3 therms.
Pyterate requires Python 3 and works on Linux, Windows and OS X.
How to install Pyterate on your system
User manual to read first
Technical reference material, for classes, methods, APIs, commands.
Development & Community¶
How to contribute to the project
How to Refer to Pyterate ?¶
Guidelines to cite Pyterate
Table of Contents¶
- 1. Overview
- 2. News
- 3. Installation
- 4. User FAQ
- 5. User Guide
- 6. Examples
- 7. Design Notes
- 8. API Documentation
- 9. Development & Community
- 10. How to Refer to Pyterate ?