Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Sphinx extension to enhance autodoc for interrogated modules

Project description

sphinx-interrogatedb

This is a Sphinx extension that provides autodoc support for modules created by interrogate, by augmenting it with information provided by interrogate databases (.in files).

Usage

To make use of this extension, the following steps are needed:

  1. Install the module using pip.
pip install sphinx-interrogatedb
  1. Enable it in conf.py.
extensions = ['sphinx.ext.autodoc', 'sphinx_interrogatedb']
  1. Configure the search path for interrogatedb files.
interrogatedb_search_path = ['dir/containing/in/files/']
  1. Just use autodoc, autosummary or autopackagesummary as you would normally, and the .in files will automatically be processed.

Configuration

The following configuration options are supported:

  • interrogatedb_search_path: list of folders to search for .in files.
  • autodoc_interrogatedb_mangle_type_names: if True, converts type names in the way that interrogate's python-native back-end does by default.
  • autodoc_interrogatedb_mangle_type_names: if True, converts type names from snake-case to camel-case. False by default.
  • autodoc_interrogatedb_type_annotations: if True, shows argument and return types in function signatures using type hint syntax. True by default.
  • autodoc_interrogatedb_add_rtype: if True, adds an :rtype: directive to the bodies of docstrings with the return type. True by default.

License

This extension has been licensed under the terms of the Modified BSD License.

Project details


Download files

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

Files for sphinx-interrogatedb, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_interrogatedb-1.0.1-py3-none-any.whl (9.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

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