Skip to main content

Sphinx extension for Read the Docs overrides

Project description

PyPI Version Build Status

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

  1. Increment the version in setup.py

  2. Tag the release in git: git tag $NEW_VERSION.

  3. Push the tag to GitHub: git push --tags origin main

  4. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readthedocs-sphinx-ext-2.2.3.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-2.2.3-py2.py3-none-any.whl (11.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file readthedocs-sphinx-ext-2.2.3.tar.gz.

File metadata

File hashes

Hashes for readthedocs-sphinx-ext-2.2.3.tar.gz
Algorithm Hash digest
SHA256 6583c26791a5853ee9e57ce9db864e2fb06808ba470f805d74d53fc50811e012
MD5 7c89424426b12275cff08030054a5eb0
BLAKE2b-256 8d0a93199a7b182f3fe7eb78a7d99be817875852416bba1d37d51878b0238957

See more details on using hashes here.

Provenance

File details

Details for the file readthedocs_sphinx_ext-2.2.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for readthedocs_sphinx_ext-2.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e9d911792789b88ae12e2be94d88c619f89a4fa1fe9e42c1505c9930a07163d8
MD5 0e9265476e264beccfcb91cbf8f4e2a2
BLAKE2b-256 e3bb4adf12e9f4f6884135ccd662fdc0dd1008e73ea9be3c1a981ce0208467f7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page