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

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-ext-1.0.4.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.4.3 requests-toolbelt/0.9.1 tqdm/4.29.0 CPython/3.6.5

File hashes

Hashes for readthedocs-sphinx-ext-1.0.4.tar.gz
Algorithm Hash digest
SHA256 33dbb135373d539233f7fbdb5e8dcfa07d41254300ee23719eb9caa8c68a40ae
MD5 75df245a0f1dbe317ce483feba8483d7
BLAKE2b-256 91ad15de3f6d3f4aa17c7348e40c0c8ba17af7df6cecd8bd75b49a2008d243e6

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 28.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.4.3 requests-toolbelt/0.9.1 tqdm/4.29.0 CPython/3.6.5

File hashes

Hashes for readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 abff1ac6b4f5c58e69c6b18debab7ca87ce19f4bd1f5773a293f7ecdb2735aa0
MD5 55588a2b5bbfe79d2270e5d3a866983e
BLAKE2b-256 4ca493282e4050478c5a9d5d4777ec32cdf6cadb6f6363f1d3cc96ad3ad12073

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