semvec/pypi-packages huggingface dataset:
jinjaapidoc 0.5.0
Sphinx API Doc with Jinja2 templates
License: BSD
Keywords: jinjaapidoc

=========================================================
Jinjaapidoc Documentation
=========================================================

.. image:: http://img.shields.io/pypi/v/jinjaapidoc.png?style=flat
    :target: https://pypi.python.org/pypi/jinjaapidoc

.. image:: https://img.shields.io/travis/storax/jinjaapidoc/master.png?style=flat
    :target: https://travis-ci.org/storax/jinjaapidoc

.. image:: http://img.shields.io/pypi/dm/jinjaapidoc.png?style=flat
    :target: https://pypi.python.org/pypi/jinjaapidoc

.. image:: https://img.shields.io/coveralls/storax/jinjaapidoc/master.png?style=flat
    :target: https://coveralls.io/r/storax/jinjaapidoc

.. image:: http://img.shields.io/pypi/l/jinjaapidoc.png?style=flat
    :target: https://pypi.python.org/pypi/jinjaapidoc




Sphinx API Doc with Jinja2 templates


Documentation
-------------

The full documentation is at http://jinjaapidoc.rtfd.org.


Features
--------

* jinjaapidoc is a tool for automatic generation of Sphinx sources that, using the `jinja2 <http://jinja.pocoo.org/docs/dev/>`_ template rendering engine, document a whole package in the style of other automatic API documentation tools. It is based of the builtin `sphinx apidoc <http://sphinx-doc.org/man/sphinx-apidoc.html>`_


.. :changelog:

History
-------

0.1.1 (2015-02-02)
+++++++++++++++++++++++++++++++++++++++

* First release on PyPI.

0.2.0 (2015-02-03)
+++++++++++++++++++++++++++++++++++++++

* Add autosummary template

0.2.1 (2015-03-11)
+++++++++++++++++++++++++++++++++++++++

* Support Sphinx 1.3
* Fix recursion

0.3.0 (2015-05-23)
+++++++++++++++++++++++++++++++++++++++

* Ignore classes and functions that got imported from other modules

0.4.0 (2016-07-09)
+++++++++++++++++++++++++++++++++++++++

* Add ``jinjaapi_include_from_all`` option to include members of a module or package
  that are listed in ``__all__`` (`#9 <https://github.com/storax/jinjaapidoc/pull/9>`_).
  Thanks to `@awhetter`_.

0.5.0 (2019-04-14)
+++++++++++++++++++++++++++++++++++++++

* Fix compatibility with Sphinx >= 1.8.
* Remove Python 2 tests.

.. _`@awhetter`: https://github.com/awhetter