https://github.com/diamondlightsource/sphinx_rtd_theme_github_versions
Sphinx readthedocs theme with support for documentation versions from github.io
https://github.com/diamondlightsource/sphinx_rtd_theme_github_versions
from-dls-controls
Last synced: 3 months ago
JSON representation
Sphinx readthedocs theme with support for documentation versions from github.io
- Host: GitHub
- URL: https://github.com/diamondlightsource/sphinx_rtd_theme_github_versions
- Owner: DiamondLightSource
- License: apache-2.0
- Created: 2021-09-21T12:51:49.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T17:41:07.000Z (over 2 years ago)
- Last Synced: 2025-02-20T12:18:54.466Z (3 months ago)
- Topics: from-dls-controls
- Language: Python
- Size: 11.5 MB
- Stars: 2
- Watchers: 36
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
sphinx_rtd_theme_github_versions
================================
|code_ci| |docs_ci| |coverage| |pypi_version| |license|
This theme inherits from sphinx_rtd_theme_ and adds an entry in the sidebar
listing all versions of the documentation on github.io for the current repo
============== ==============================================================
PyPI ``pip install sphinx_rtd_theme_github_versions``
Source code https://github.com/DiamondLightSource/sphinx_rtd_theme_github_versions
Documentation https://DiamondLightSource.github.io/sphinx_rtd_theme_github_versions
Releases https://github.com/DiamondLightSource/sphinx_rtd_theme_github_versions/releases
============== ==============================================================
|screenshot|
.. |code_ci| image:: https://github.com/DiamondLightSource/sphinx_rtd_theme_github_versions/workflows/Code%20CI/badge.svg?branch=master
:target: https://github.com/DiamondLightSource/sphinx_rtd_theme_github_versions/actions?query=workflow%3A%22Code+CI%22
:alt: Code CI
.. |docs_ci| image:: https://github.com/DiamondLightSource/sphinx_rtd_theme_github_versions/workflows/Docs%20CI/badge.svg?branch=master
:target: https://github.com/DiamondLightSource/sphinx_rtd_theme_github_versions/actions?query=workflow%3A%22Docs+CI%22
:alt: Docs CI
.. |coverage| image:: https://codecov.io/gh/DiamondLightSource/sphinx_rtd_theme_github_versions/branch/master/graph/badge.svg
:target: https://codecov.io/gh/DiamondLightSource/sphinx_rtd_theme_github_versions
:alt: Test Coverage
.. |pypi_version| image:: https://img.shields.io/pypi/v/sphinx_rtd_theme_github_versions.svg
:target: https://pypi.org/project/sphinx_rtd_theme_github_versions
:alt: Latest PyPI version
.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0
:alt: Apache License
.. _sphinx_rtd_theme: https://pypi.org/project/sphinx-rtd-theme/
..
Anything below this line is used when viewing README.rst and will be replaced
when included in index.rst
.. |screenshot| image:: https://raw.githubusercontent.com/DiamondLightSource/sphinx_rtd_theme_github_versions/master/docs/images/screenshot.png
See https://DiamondLightSource.github.io/sphinx_rtd_theme_github_versions for more detailed documentation.