Skip to main content

Sphinx API Doc with Jinja2 templates

Project description

Sphinx API Doc with Jinja2 templates


The full documentation is at


  • 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


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.

0.5.0 (2019-04-14)

  • Fix compatibility with Sphinx >= 1.8.

  • Remove Python 2 tests.

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.5.0.tar.gz (12.1 kB view hashes)

Uploaded source

Built Distribution

jinjaapidoc-0.5.0-py2.py3-none-any.whl (11.6 kB view hashes)

Uploaded py2 py3

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