Skip to main content

Sphinx SCM interface

Project description

[Latest PyPI version] [Supported Python versions] [pre-commit: enabled] [pre-commit.ci status] [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). Currently, 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.5.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_scm-0.1.5-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib_scm-0.1.5.tar.gz.

File metadata

  • Download URL: sphinxcontrib_scm-0.1.5.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for sphinxcontrib_scm-0.1.5.tar.gz
Algorithm Hash digest
SHA256 c0f75bd55f2e822609879ff0fefd0ad53828fabb142fa91512d465c31521e7ee
MD5 23a7d28613d89fada65a128c2150cf82
BLAKE2b-256 dd06b406a800d4dc03a9fcf9834e0ca586473744078c3bc718162bd698aeb56b

See more details on using hashes here.

File details

Details for the file sphinxcontrib_scm-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_scm-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 046453a3357ee0ab3571a496fbda0723098f60fc095ab4141607b3c6760d456f
MD5 a2c6566b2644afc8cc8e1386b341bcb0
BLAKE2b-256 19a8865b179df0f073cb14862aa8769df8b311d49e2ceeb92156d1cccae77cf6

See more details on using hashes here.

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