sphinx_version_ref
This extension adds a single role to Sphinx. With :version-ref:`<ref>` one can substitute the version given in conf.py into <ref>.
Usage
In your conf.py file:
release = '1.4.1a5'
version = '.'.join(release.split('.')[:2])
extensions = ['sphinx_version_ref']
Where version can of course be any string. The following uses of <ref> then will be parsed as:
Entered as <ref> |
Parsed as |
|---|---|
https://docs.com/{version}/index.html |
`https://docs.com/1.4/index.html`_ |
{version} <http://github.com/user/project/tree/{version}> |
`1.4 <http://github.com/user/project/tree/1.4>`_ |
See version {version} <http://github.com/user/project/tree/{release}> |
`See version 1.4 <http://github.com/user/project/tree/1.4.1a5>`_ |
See the docs for more information.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-version-ref 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-version-ref-0.1.0.tar.gz | 5.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_version_ref-0.1.0-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 9.5 kB
Release files / sphinx-version-ref-0.1.0.tar.gz
| Download URL | sphinx-version-ref-0.1.0.tar.gz |
|---|---|
| Size | 5.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c72d70a7c501e41859a8f9c35559821022f3bc0b1be2dcd06ada8013cbe2cdd2
|
|
BLAKE2b-256 checksum How to use checksums |
a19e587fd650393c88bd075f30442c089d311ed621c5980bf418f4acb5f334ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/2.7.12
|
Release files / sphinx_version_ref-0.1.0-py2-none-any.whl
| Download URL | sphinx_version_ref-0.1.0-py2-none-any.whl |
|---|---|
| Size | 3.6 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
5748efe10b4b4dce2279341ec2f5b06d9c3119e08d3b13635252b1ba81d0c39b
|
|
BLAKE2b-256 checksum How to use checksums |
9df86b0ec805e2930339d82cf6c1ff91134c035ec5c265077b48f513db03480a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/2.7.12
|
