https://github.com/readthedocs/readthedocs-sphinx-ext

[RTD Internal] This is an extension that we install on all Sphinx builds on Read the Docs
https://github.com/readthedocs/readthedocs-sphinx-ext

Last synced: 4 days ago
JSON representation

[RTD Internal] This is an extension that we install on all Sphinx builds on Read the Docs

• Host: GitHub
• URL: https://github.com/readthedocs/readthedocs-sphinx-ext
• Owner: readthedocs
• License: mit
• Created: 2013-09-03T02:23:23.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2023-12-19T09:59:48.000Z (11 months ago)
• Last Synced: 2024-09-19T15:48:07.814Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 325 KB
• Stars: 17
• Watchers: 11
• Forks: 35
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Read the Docs Sphinx Extensions

===============================

.. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg

   :target: https://pypi.python.org/pypi/readthedocs-sphinx-ext

   :alt: PyPI Version

.. image:: https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext.svg?style=svg

   :target: https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext

   :alt: 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

---------

#. Increment the version in ``setup.py``

#. Tag the release in git: ``git tag $NEW_VERSION``.

#. Push the tag to GitHub: ``git push --tags origin main``

#. Upload the package to PyPI:

    .. code:: bash

        $ python -m pip install --upgrade pip build twine

        $ rm -rf dist/

        $ python -m build --sdist --wheel

        $ twine upload --username=__token__ --password=$PYPI_TOKEN dist/*