Skip to main content

Sphinx API Doc with Jinja2 templates

Project description

=========================================================
Jinja Api Documentation
=========================================================

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

.. image:: https://travis-ci.org/storax/jinjaapidoc.png?branch=master
:target: https://travis-ci.org/storax/jinjaapidoc

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

.. image:: https://coveralls.io/repos/storax/jinjaapidoc/badge.png
:target: https://coveralls.io/r/storax/jinjaapidoc

.. image:: http://img.shields.io/pypi/l/jinjaapidoc.svg
: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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jinjaapidoc-0.1.1.zip (16.3 kB view hashes)

Uploaded Source

Built Distribution

jinjaapidoc-0.1.1-py2.py3-none-any.whl (10.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page