![[Latest PyPI version]](https://pypi-camo.freetls.fastly.net/96e738099fe20f3e5578cef6ad7eced323733109/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f737068696e78636f6e747269622d73636d2e737667)
![[Supported Python versions]](https://pypi-camo.freetls.fastly.net/f1eacddd8ca17c4b5840722938a31aa76434527e/68747470733a2f2f696d672e736869656c64732e696f2f707970692f707976657273696f6e732f737068696e78636f6e747269622d73636d2e737667)
![[pre-commit: enabled]](https://pypi-camo.freetls.fastly.net/4abb85bbb3e31fcf7cd1be5a440d77a3e1a9d6fe/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7072652d2d636f6d6d69742d656e61626c65642d627269676874677265656e2e7376673f6c6f676f3d7072652d636f6d6d6974266c6f676f436f6c6f723d7768697465)
![[pre-commit.ci status]](https://pypi-camo.freetls.fastly.net/48402cf52cb3a292f66f50c8eef6ea247099019c/68747470733a2f2f726573756c74732e7072652d636f6d6d69742e63692f62616467652f6769746875622f737068696e782d636f6e747269622f73636d2f6d61737465722e737667)
![[Code style: black]](https://pypi-camo.freetls.fastly.net/fbfdc7754183ecf079bc71ddeabaf88f6cbc5c00/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d626c61636b2d3030303030302e737667)
![[Code style: prettier]](https://pypi-camo.freetls.fastly.net/aedf3c98fb8318fe049fa1c12589c7555ff0b9c6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d70726574746965722d6666363962342e737667)
This package provides sphinxcontrib.scm, a simple SCM interface for Sphinx-based documentation.
Installation
pip install sphinxcontrib-scm
Configuration
Add 'sphinxcontrib.scm' to the extensions list in conf.py.
extensions = [ 'sphinxcontrib.scm' ]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.
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-scm 0.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib_scm-0.1.5.tar.gz | 21.4 kB | Without provenance | Details for sphinxcontrib_scm-0.1.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinxcontrib_scm-0.1.5-py3-none-any.whl | Python 3 | none | any | Details for sphinxcontrib_scm-0.1.5-py3-none-any.whl |
Total release size: 39.3 kB
Release files / sphinxcontrib_scm-0.1.5.tar.gz
| Download URL | sphinxcontrib_scm-0.1.5.tar.gz |
|---|---|
| Size | 21.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c0f75bd55f2e822609879ff0fefd0ad53828fabb142fa91512d465c31521e7ee
|
|
BLAKE2b-256 checksum How to use checksums |
dd06b406a800d4dc03a9fcf9834e0ca586473744078c3bc718162bd698aeb56b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Release files / sphinxcontrib_scm-0.1.5-py3-none-any.whl
| Download URL | sphinxcontrib_scm-0.1.5-py3-none-any.whl |
|---|---|
| Size | 17.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
046453a3357ee0ab3571a496fbda0723098f60fc095ab4141607b3c6760d456f
|
|
BLAKE2b-256 checksum How to use checksums |
19a8865b179df0f073cb14862aa8769df8b311d49e2ceeb92156d1cccae77cf6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Security for sphinxcontrib-scm 0.1.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
