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

  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.17.tar.gz (9.7 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.17-py2.py3-none-any.whl (11.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: readthedocs-sphinx-ext-0.5.17.tar.gz
  • Upload date:
  • Size: 9.7 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.17.tar.gz
Algorithm Hash digest
SHA256 21097cbb37c9a0590e2cb444b55bd87302fc8f69640fa2d4f2d113e98e9558ff
MD5 02c4a8a78d3bf65bafeef51734b5c447
BLAKE2b-256 c921d091b13bb3410c032be6e86d557e1eefacfa5f83235a131cf95a437415aa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readthedocs_sphinx_ext-0.5.17-py2.py3-none-any.whl
  • Upload date:
  • Size: 11.9 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.17-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d0fd65a9dffc187da94136ff5485e5b3ea96a4734559b1adc7954c1bc1658aa3
MD5 797dec668431baf95d2f2b6a15ae7b40
BLAKE2b-256 d1f368de6af559ae681921a7b676a86c360454de67f3c8bd5327ae9352897ef4

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