Archived
This project has been archived by its maintainers, and is no longer receiving any updates.
sphinx-github-role
A github role for Sphinx.
Installation
To install, run
(.venv) $ pip install sphinx-github-role
Usage
Basic usage
MyST:
:caption: index.md
See {github}`astrojuanlu/sphinx-github-role#1`.
reStructuredText:
:caption: index.rst
See :github:`astrojuanlu/sphinx-github-role#1`.
Configuring a default organization and project
The extension accepts a configuration github_default_org_project
that can be a tuple ("default_org", "default_project")
to save some typing. For example, with this configuration:
:caption: conf.py
github_default_org_project = ("astrojuanlu", None)
you can type this:
:caption: index.md
See {github}`sphinx-github-role#1`.
and with this configuration:
:caption: conf.py
github_default_org_project = ("astrojuanlu", "sphinx-github-role")
you only need to type this:
:caption: index.md
See {github}`#1`.
Customizing link text
You can also customize the link text, by wrapping the target in angle brackets:
:caption: index.md
See {github}`this issue <#1>`.
Contribute
Feel free to open an issue to report problems or suggest new features!
1 maintainer
Metadata
1 maintainer
Release files for sphinx-github-role 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-github-role-0.1.0.tar.gz | 2.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_github_role-0.1.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 5.9 kB
Release files / sphinx-github-role-0.1.0.tar.gz
| Download URL | sphinx-github-role-0.1.0.tar.gz |
|---|---|
| Size | 2.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7a16424320cdb44ef130090bc8cedafd514491486e779688f7f6eec98f7ec0cb
|
|
BLAKE2b-256 checksum How to use checksums |
8392427a9505d913a39fe351212781634bf05f9da487826dd81fc700f1376edb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
|
Release files / sphinx_github_role-0.1.0-py2.py3-none-any.whl
| Download URL | sphinx_github_role-0.1.0-py2.py3-none-any.whl |
|---|---|
| Size | 3.1 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
f46729cb815e678c45501c564ebb2b5e1076e56cef517cdc057c4dde0621dabd
|
|
BLAKE2b-256 checksum How to use checksums |
8cf6ee97a8dfdc71827fde91383effcfb4877a5f7bca7247d728b163fad2233b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
|
