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.

0.5.0 (2019-04-14)

  • Fix compatibility with Sphinx >= 1.8.

  • Remove Python 2 tests.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for storax from gravatar.com storax

Credits

Author: David Zuber

License

BSD License (BSD)

Tags

jinjaapidoc

Classifiers

Report project as malware

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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 2Python 3

File details

Details for the file jinjaapidoc-0.5.0.tar.gz.

File metadata

  • Download URL: jinjaapidoc-0.5.0.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for jinjaapidoc-0.5.0.tar.gz
Algorithm Hash digest
SHA256 31cd7c1c1a1462bfea60debdea128364cc7f98ce2603df8a1c05f18576de8185
MD5 4f8edb42fcafd08f6ab41deb37811d5b
BLAKE2b-256 d4e249ec2898662d39a38d1428fef69b66c7a8dd11ccacbbea7654de60c224c9

See more details on using hashes here.

File details

Details for the file jinjaapidoc-0.5.0-py2.py3-none-any.whl.

File metadata

  • Download URL: jinjaapidoc-0.5.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for jinjaapidoc-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6e667fe518187c619168d472996d94a10de0f4d7769b2a34a9a9e6fa3188d4c3
MD5 399e8a60d025e851373f06572e587e1a
BLAKE2b-256 97871a8df9023b1771e1f7b5ce9d9b3e8a36c6da094435c2544acec5e60c76ad

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 files

0.4.0

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.1

1 file

0.2.0

2 files

0.1.1

2 files

0.1.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page