sphinx-github-role
Project description
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!
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.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f46729cb815e678c45501c564ebb2b5e1076e56cef517cdc057c4dde0621dabd |
|
MD5 | c7278e4d7877dcecff781fa4559c222b |
|
BLAKE2b-256 | 8cf6ee97a8dfdc71827fde91383effcfb4877a5f7bca7247d728b163fad2233b |