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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-ext-2.2.1.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for readthedocs-sphinx-ext-2.2.1.tar.gz
Algorithm Hash digest
SHA256 e35ddacb52af972751926d01bcc082014751762d9ba68cb0c249df9edb216bbd
MD5 8d01d743a4cea2e93b107cd473d9cc47
BLAKE2b-256 7b61a2e006133cfbded65225641ac332da6fb44123fbc6ed40e7b50e85b3150e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for readthedocs_sphinx_ext-2.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 29c77e273dccc7adf0dc6b5461e0962fe628bbc97d272e64ed6849fd5ba9f108
MD5 9a13dd83fd824479438acb334e563e66
BLAKE2b-256 4ffea72680eb75de04d3dded3b6456862368fbe4c45e0e3a18e361cc885b3fd9

See more details on using hashes here.

Supported by

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