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 --sign --identity security@readthedocs.org 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.0.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl (11.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for readthedocs-sphinx-ext-2.2.0.tar.gz
Algorithm Hash digest
SHA256 e5effcd825816111a377ab7a897b819215138f8e5e8acc86f99218328f957240
MD5 4f88c622bb914f242dc1409e09ae9ee3
BLAKE2b-256 f3559e440437dcf29ad69963247050872acb981e0ab728c3cc2405b66d124593

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d801f0bfb125d2837f18f40451462528d4a97eefd8de8a12ad526b4f1ce14205
MD5 77bff4cb5b4f52e2a3c90d9f15c545fd
BLAKE2b-256 91631228bc6c9162b19c5553697fa29eb60d734ba5967378b44f07c2512ae91e

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