.. -- Mode: rst --
.. -- Mode: rst --
.. |PyterateUrl| |PyterateHomePage| |PyterateDoc| |Pyterate@github| |Pyterate@readthedocs| |Pyterate@readthedocs-badge| |Pyterate@pypi|_
.. |ohloh| image:: https://www.openhub.net/accounts/230426/widgets/account_tiny.gif :target: https://www.openhub.net/accounts/fabricesalvaire :alt: Fabrice Salvaire's Ohloh profile :height: 15px :width: 80px
.. |PyterateUrl| replace:: https://fabricesalvaire.github.io/Pyterate
.. |PyterateHomePage| replace:: Pyterate Home Page .. _PyterateHomePage: https://fabricesalvaire.github.io/Pyterate
.. |Pyterate@readthedocs-badge| image:: https://readthedocs.org/projects/Pyterate/badge/?version=latest :target: http://Pyterate.readthedocs.org/en/latest
.. |Pyterate@github| replace:: https://github.com/FabriceSalvaire/Pyterate .. .. _Pyterate@github: https://github.com/FabriceSalvaire/Pyterate
.. |Pyterate@pypi| replace:: https://pypi.python.org/pypi/Pyterate .. .. _Pyterate@pypi: https://pypi.python.org/pypi/Pyterate
.. |Build Status| image:: https://travis-ci.org/FabriceSalvaire/Pyterate.svg?branch=master :target: https://travis-ci.org/FabriceSalvaire/Pyterate :alt: Pyterate build status @travis-ci.org
.. |Pypi Version| image:: https://img.shields.io/pypi/v/Pyterate.svg :target: https://pypi.python.org/pypi/Pyterate :alt: Pyterate last version
.. |Pypi License| image:: https://img.shields.io/pypi/l/Pyterate.svg :target: https://pypi.python.org/pypi/Pyterate :alt: Pyterate license
.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/Pyterate.svg :target: https://pypi.python.org/pypi/Pyterate :alt: Pyterate python version
.. coverage test .. https://img.shields.io/pypi/status/Django.svg .. https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star
.. End .. -- Mode: rst --
.. |Python| replace:: Python .. _Python: http://python.org
.. |PyPI| replace:: PyPI .. _PyPI: https://pypi.python.org/pypi
.. |Numpy| replace:: Numpy .. _Numpy: http://www.numpy.org
.. |IPython| replace:: IPython .. _IPython: http://ipython.org
.. |Sphinx| replace:: Sphinx .. _Sphinx: http://sphinx-doc.org
.. |Matplotlib| replace:: Matplotlib .. _Matplotlib: http://matplotlib.org
.. |Circuit_macros| replace:: Circuit_macros .. _Circuit_macros: http://ece.uwaterloo.ca/~aplevich/Circuit_macros
.. |Tikz| replace:: Tikz .. _Tikz: http://www.texample.net/tikz
.. End
|Pypi License| |Pypi Python Version|
|Pypi Version|
Production Branch <https://github.com/FabriceSalvaire/Pyterate/tree/master>
_Devel Branch <https://github.com/FabriceSalvaire/Pyterate/tree/devel>
_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 <https://jupyterbook.org>
_ does a similar job than Pyterate.
The main differences are:
See also:
Pweave <https://github.com/mpastell/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 |PyterateHomePage|_.
The documentation generator features:
LaTeX formulae <https://www.mathjax.org>
_, figures and plotsreStructuredText <https://en.wikipedia.org/wiki/ReStructuredText>
or Markdown <https://en.wikipedia.org/wiki/Markdown>
syntax for textLook at the installation <https://fabricesalvaire.github.io/Pyterate/installation.html>
_ section in the documentation.
Authors: Fabrice Salvaire <http://fabrice-salvaire.fr>
_
.. -- Mode: rst --
.. no title here
Extracted source from https://github.com/FabriceSalvaire/PySpice
.. End
.. End