sphinxcontrib-scm

This package provides sphinxcontrib.scm, a simple SCM interface for Sphinx-based documentation.

Installation

1. pip install sphinxcontrib-scm

Configuration

1. Add 'sphinxcontrib.scm' to the extensions list in conf.py.

   extensions = [ 'sphinxcontrib.scm' ]

2. Configure in conf.py

   scm_contribs_email = ["true"|"false"]          # Show email. Default: "true"
   scm_contribs_limit_contributors" = [None|int]  # Limit number of contributors. Use None
                                                  # to deactivate. Default: None
   scm_contribs_min_commits = int                 # Filter by number of commits. Default: 0
   scm_contribs_sort = ["name"|"num"]             # Sort by name or number of commits.
                                                  # Default: "name"
   scm_contribs_type = ["author"|"committer"]     # Show info of author or committer.
                                                  # Default: "author"

Usage

Directive

.. scm-sectionauthor::
   :email: [true|false]
   :limit_contributors: [<int>]
   :min_commits: [<int>]
   :sort: [name|num]
   :type: [author|committer]

Populates sectionauthor directive with a list of SCM contributors. All options are optional and override the config settings in conf.py.

Role

:scm-contribs:`.`

Can be used inline (eg as content for the sectionauthor directive). Currently, email addresses are not converted into mailto links.