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:

    $ rm -rf dist/
    $ python setup.py sdist bdist_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.1.8.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-2.1.8-py2.py3-none-any.whl (11.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for readthedocs-sphinx-ext-2.1.8.tar.gz
Algorithm Hash digest
SHA256 a57e3713daf77bf91d1ba19e4b9888a47c0abfeb63ecf02e3ac77fcfd99bfe69
MD5 ecaaee440cb231bab66328c09b120567
BLAKE2b-256 6638ff8fa740da95658293f6f5823e93e1f2594789268ea221fe17ab7235bddd

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for readthedocs_sphinx_ext-2.1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5ab5875993191e5e526ca196a1082b73116b0cefd79073ab25367ba0458fffe9
MD5 06a70c1dbc2896794c1ab3e8657e9bf4
BLAKE2b-256 97fe0508ba81853ac3807eb35f05c3b5283d710fdd0687ad3e6051ce728417d8

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