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.16.tar.gz (8.4 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-0.5.16-py2.py3-none-any.whl (11.7 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-ext-0.5.16.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for readthedocs-sphinx-ext-0.5.16.tar.gz
Algorithm Hash digest
SHA256 42b1c63d63dd483a188b541599bd08a540b2d08ec2b166660179618b6ccc3bb0
MD5 5e9aa5883b1c08bb347b5162f0f1cfec
BLAKE2b-256 75c8e0b15ed38b69e2f1ac4c5999099155fd6931d20feeb2583e052a81592948

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readthedocs_sphinx_ext-0.5.16-py2.py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for readthedocs_sphinx_ext-0.5.16-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e73770f53a226f6db8199916a12bcee1808e0c0cbe028422668e8c1c7f2fa80c
MD5 e47d5e71a8c4224ad8790fc34ad49d18
BLAKE2b-256 a519abebb2ac7554119cc56d77ce03abcb17b200d6cc3b04dce05cd31248f06f

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