Metadata-Version: 2.1
Name: Pyterate
Version: 2.1.0
Summary: Pyterate is a Sphinx add-ons to generate API documentation using autogen and litterate programming documentation for Python projects.
Home-page: https://github.com/FabriceSalvaire/Pyterate
Author: Fabrice SALVAIRE
Author-email: fabrice.salvaire@orange.fr
Maintainer: Fabrice SALVAIRE
Maintainer-email: fabrice.salvaire@orange.fr
License: GPLv3
Project-URL: Documentation, https://fabricesalvaire.github.io/Pyterate
Project-URL: Code, https://github.com/FabriceSalvaire/Pyterate
Project-URL: Issue Tracker, https://github.com/FabriceSalvaire/Pyterate/issues
Description: .. -*- 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
        
        ==========
         Pyterate
        ==========
        
        |Pypi License|
        |Pypi Python Version|
        
        |Pypi Version|
        
        * Quick Link to `Production Branch <https://github.com/FabriceSalvaire/Pyterate/tree/master>`_
        * Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/Pyterate/tree/devel>`_
        
        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 |PyterateHomePage|_.
        
        What are the main features ?
        ----------------------------
        
        The documentation generator features:
        
          * intermixing of code, text, `LaTeX formulae <https://www.mathjax.org>`_, figures and plots
          * use the `reStructuredText <https://en.wikipedia.org/wiki/ReStructuredText>`_ or `Markdown
            <https://en.wikipedia.org/wiki/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 <https://fabricesalvaire.github.io/Pyterate/installation.html>`_ section in the documentation.
        
        Credits
        =======
        
        Authors: `Fabrice Salvaire <http://fabrice-salvaire.fr>`_
        
        News
        ====
        
        .. -*- Mode: rst -*-
        
        
        .. no title here
        
        V2 2017-11-28
        -------------
        
        * new design
        
        V1 2017-11-10
        -------------
        
        Extracted source from https://github.com/FabriceSalvaire/PySpice
        
        .. End
        
        .. End
        
Keywords: sphinx,autogen,documentation,generator,builder,literate,programming
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.4
Description-Content-Type: text/x-rst
