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

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl (29.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-ext-2.1.4.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.8

File hashes

Hashes for readthedocs-sphinx-ext-2.1.4.tar.gz
Algorithm Hash digest
SHA256 2ba023376057c6ba5d07b4fd016ec1d526f1b4fc5ad7a7ce7f0ed8a91dc54bbe
MD5 c97f54091d5d841f19187a0a91475565
BLAKE2b-256 35a223124e5367b552206fcff99bbf77de129ebd0cb6bc501111388cedcf2d62

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.8

File hashes

Hashes for readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 671c9d5dc845a4ed35a2b60293c403eebc9acf26d33b153012a9f6f22bb4e589
MD5 562841edd11541c1decff297fb308c1e
BLAKE2b-256 ed182a7348235e84b53b4abc33bbfe7696a99e9f4f2f97818bf940561cb03d9b

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