Skip to content

raphaelBarman/sphinx-autosummary-dhsegment

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sphinx-autosummary-dhsegment

This is a Sphinx extension to generate API documentation for the config system of dhSegment using the built-in autosummary extension.

The extension makes it possible to lookup the config type name of a class and add a third column to the autosummary usual two columns.

Usage

  1. Install the module using pip.
pip install git+https://github.com/raphaelBarman/sphinx-autosummary-dhsegment.git@master
  1. Enable it in conf.py.
extensions = ['sphinx.ext.autosummary', 'sphinx_autosummary_dhsegment']

autosummary_generate = True
  1. When needed, replace autosummary by autosummarydhsegment

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages