2025 Python Packaging Survey is now live!  Take the survey now

Sphinx extension for Read the Docs overrides

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for agj from gravatar.com agj Avatar for davidfischer from gravatar.com davidfischer Avatar for ericholscher from gravatar.com ericholscher Avatar for humitos from gravatar.com humitos Avatar for stsewd from gravatar.com stsewd

Unverified details

These details have not been verified by PyPI
Project links
Meta
Report project as malware

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 main

  4. Upload the package to PyPI:

    $ rm -rf dist/
$ python setup.py sdist bdist_wheel
$ twine upload --sign --identity security@readthedocs.org dist/*

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page