Skip to main content

Sphinx SCM interface

Project description

[Latest PyPI version] [Supported Python versions] [pre-commit: enabled] [Code style: black] [Code style: prettier]

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. Currenlty, email addresses are not converted into mailto links.

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

sphinxcontrib-scm-0.1.2.tar.gz (19.9 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_scm-0.1.2-py3-none-any.whl (18.0 kB view hashes)

Uploaded Python 3

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