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.5.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-2.2.5-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.5.tar.gz.

File metadata

File hashes

Hashes for readthedocs-sphinx-ext-2.2.5.tar.gz
Algorithm Hash digest
SHA256 ee5fd5b99db9f0c180b2396cbce528aa36671951b9526bb0272dbfce5517bd27
MD5 822b8481398c118b9f5ab1ccabf7661d
BLAKE2b-256 e8ce38130d8dec600bf5413eb89a3413dd38f204c7c728c4947e12ff8cb793b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f8c56184ea011c972dd45a90122568587cc85b0127bc9cf064d17c68bc809daa
MD5 687c20601c75f7984d3bfbb3a39ab3f3
BLAKE2b-256 6471c89e7709a0d4f93af1848e9855112299a820b470d84f917b4dd5998bdd07

See more details on using hashes here.

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