Skip to main content
Help us improve Python packaging – donate today!

Sphinx API Doc with Jinja2 templates

Project Description

http://img.shields.io/pypi/v/jinjaapidoc.png?style=flat https://img.shields.io/travis/storax/jinjaapidoc/master.png?style=flat http://img.shields.io/pypi/dm/jinjaapidoc.png?style=flat https://img.shields.io/coveralls/storax/jinjaapidoc/master.png?style=flat http://img.shields.io/pypi/l/jinjaapidoc.png?style=flat

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 template rendering engine, document a whole package in the style of other automatic API documentation tools. It is based of the builtin sphinx apidoc

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). Thanks to @awhetter.

Release history Release notifications

This version
History Node

0.4.0

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.2.1

History Node

0.2.0

History Node

0.1.1

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
jinjaapidoc-0.4.0-py2.py3-none-any.whl (11.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 9, 2016
jinjaapidoc-0.4.0.tar.gz (12.0 kB) Copy SHA256 hash SHA256 Source None Jul 9, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page