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 master

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

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-2.1.2-py2.py3-none-any.whl (11.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-ext-2.1.2.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.9.1

File hashes

Hashes for readthedocs-sphinx-ext-2.1.2.tar.gz
Algorithm Hash digest
SHA256 302c58847ab0fe65e16dd5d2e609285e78b567c444ad59194caa2ffc323d348d
MD5 56993fde03a975aba43d0392b1d69eb4
BLAKE2b-256 8bf5bba210f3e5488abf900ce8ee99c2e4b6bce068b22e902cde0b5bfbe785eb

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: readthedocs_sphinx_ext-2.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.9.1

File hashes

Hashes for readthedocs_sphinx_ext-2.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8bc8c209ce47d42048eb56d0de5857ea4d041c7357414ac1343b1df75271bb3c
MD5 1e3d7aa0ba9cb964f4d4c2357fea5b2c
BLAKE2b-256 dd7afcaf1a9649be0fefe8e2791ba957e129f5d024e6df47c13ac7b70ea79e4f

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