Skip to main content

Sphinx extension for Read the Docs overrides

Project description

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

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

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-0.5.15-py2.py3-none-any.whl (11.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-ext-0.5.15.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.5

File hashes

Hashes for readthedocs-sphinx-ext-0.5.15.tar.gz
Algorithm Hash digest
SHA256 5541ff06e568451925dc76894fbff4d5baf8d5cb03e96ebfda082b1818e26dc2
MD5 bafaab10390c98f6623d8422946cbb4c
BLAKE2b-256 be48d89d2ec6716effebe6f34eaa479a9531486becddee492383c3b3c114206a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readthedocs_sphinx_ext-0.5.15-py2.py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.5

File hashes

Hashes for readthedocs_sphinx_ext-0.5.15-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e8d292ad033db9dcb174f03f28e7cf5e2e3dd3623f5b55fca422d7272b72ccdd
MD5 849e9586798f0b64c070e9bcd5f17542
BLAKE2b-256 2bc5126eb75a57918bb3d2f858ddda05f5670d6f07bfa356bc8870e2885f6aac

See more details on using hashes here.

Supported by

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