Sphinx extension for Read the Docs overrides
Project description
This module adds extensions that make Sphinx easier to use. Some of them require Read the Docs features, others are just code that we ship and enable during builds on Read the Docs.
We currently ship:
An extension for building docs like Read the Docs
template-meta - Allows users to specify template overrides in per-page context.
Releasing
Increment the version in setup.py
Tag the release in git: git tag $NEW_VERSION.
Push the tag to GitHub: git push --tags origin main
Upload the package to PyPI:
$ python -m pip install --upgrade pip build twine $ rm -rf dist/ $ python -m build --sdist --wheel $ twine upload --username=__token__ --password=$PYPI_TOKEN dist/*
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
File details
Details for the file readthedocs-sphinx-ext-2.2.5.tar.gz
.
File metadata
- Download URL: readthedocs-sphinx-ext-2.2.5.tar.gz
- Upload date:
- Size: 12.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee5fd5b99db9f0c180b2396cbce528aa36671951b9526bb0272dbfce5517bd27 |
|
MD5 | 822b8481398c118b9f5ab1ccabf7661d |
|
BLAKE2b-256 | e8ce38130d8dec600bf5413eb89a3413dd38f204c7c728c4947e12ff8cb793b7 |
File details
Details for the file readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl
.
File metadata
- Download URL: readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8c56184ea011c972dd45a90122568587cc85b0127bc9cf064d17c68bc809daa |
|
MD5 | 687c20601c75f7984d3bfbb3a39ab3f3 |
|
BLAKE2b-256 | 6471c89e7709a0d4f93af1848e9855112299a820b470d84f917b4dd5998bdd07 |