sphinxcontrib_github_alt

Link to GitHub issues, pull requests, commits and users for a particular project.

To use this extension, add it to the extensions list in conf.py, and set the variable github_project_url:

extensions = [...
              'sphinxcontrib_github_alt',
             ]

github_project_url = "https://github.com/ipython/ipython"

Then use these roles in your documentation:

* :ghissue:`12` - link to issue #12
* :ghpull:`35` - link to pull request #35
* :ghcommit:`3a1cb54` - link to commit
* :ghuser:`ipython` - link to a user or organisation

It’s called ‘alt’ because sphinxcontrib-github already exists. IPython & Jupyter projects have been using the syntax defined in this extension for some time before we made it into its own package, so we didn’t want to switch to sphinxcontrib-github.

Metadata

Release files for sphinxcontrib_github_alt 1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxcontrib_github_alt 1.2
File	Size	Uploaded	Provenance
sphinxcontrib_github_alt-1.2.tar.gz	4.0 kB	Apr 27, 2020	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib_github_alt 1.2
File	Interpreter	ABI	Platform	Reset
sphinxcontrib_github_alt-1.2-py2.py3-none-any.whl 4.3 kB Apr 27, 2020 Without provenance	Python 3, Python 2	none	any	Details

Total release size: 8.3 kB

Release files / sphinxcontrib_github_alt-1.2.tar.gz

Download URL	sphinxcontrib_github_alt-1.2.tar.gz
Size	4.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`cfd7584d559bb89a1dde3b418fea3b5b8e601e1f50459873635256b5d1712af5`
BLAKE2b-256 checksum How to use checksums	`b8d52880f4f441f3b46f264cb031d9e7135714b5060c895c8a6458051002c41a`
Upload date	Apr 27, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`python-requests/2.23.0`

Release files / sphinxcontrib_github_alt-1.2-py2.py3-none-any.whl

Download URL	sphinxcontrib_github_alt-1.2-py2.py3-none-any.whl
Size	4.3 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`cdd1f61090e9ca1f317283dc85b311d788864d7e41baa479882c9fc914b43641`
BLAKE2b-256 checksum How to use checksums	`7012d9b6bf8093906108017f3cdbecae3e2b3b4963c5112b28f0cd482b433182`
Upload date	Apr 27, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`python-requests/2.23.0`

Security for sphinxcontrib_github_alt 1.2

Report project as malware

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.