sphinx-github-role
Project description
sphinx-github-role
A github
role for Sphinx.
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!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinx_github_role-0.1b3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a29802a94755bee0f7d69cda9dce851b2dc47cfc0cd29f95e2e19322bb46497f |
|
MD5 | 5f3246f88f55c8595522c63c98489552 |
|
BLAKE2b-256 | 30a6735246bbf79756447223ff975d046dcbb5d81da24d5af05c0e516425ef67 |