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

Uploaded Source

Built Distribution

readthedocs_sphinx_ext-1.0.1-py2.py3-none-any.whl (14.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-ext-1.0.1.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.3

File hashes

Hashes for readthedocs-sphinx-ext-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c920d8129752ee3f339c8cf3dfeba800a25730249d6ab43dc9b3c384312d1d32
MD5 3ba91abb07855e766dd2e5d443a20e7a
BLAKE2b-256 d8b86d59e6798a537a3a9b7a5de76c5e1325b75881b33ed589c6a2137718db29

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: readthedocs_sphinx_ext-1.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.3

File hashes

Hashes for readthedocs_sphinx_ext-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 52501523f05fdbe8342bce816b4d19760d799cbf6e9c221a91c11caa8da387cb
MD5 9f5192ee9626623541735b33780775dd
BLAKE2b-256 8ab573b740dc7182b4f458de18ab54adaf5698ace3a723569c5e2a748130a314

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