Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/domdfcoding/domdf_sphinx_theme
Customised 'sphinx_rtd_theme' used by my Python projects.
https://github.com/domdfcoding/domdf_sphinx_theme
documentation python sphinx sphinx-theme
Last synced: 21 days ago
JSON representation
Customised 'sphinx_rtd_theme' used by my Python projects.
- Host: GitHub
- URL: https://github.com/domdfcoding/domdf_sphinx_theme
- Owner: domdfcoding
- License: other
- Created: 2020-07-28T21:46:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T09:48:39.000Z (4 months ago)
- Last Synced: 2024-08-08T20:39:19.755Z (3 months ago)
- Topics: documentation, python, sphinx, sphinx-theme
- Language: CSS
- Homepage: https://domdf_sphinx_theme.readthedocs.io/en/latest
- Size: 595 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
###################
domdf_sphinx_theme
###################
.. start short_desc
**Customised 'sphinx_rtd_theme' used by my Python projects.**
.. end short_desc
Based on `sphinx_rtd_theme `_ by ReadTheDocs.
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/domdf-sphinx-theme/latest?logo=read-the-docs
:target: https://domdf-sphinx-theme.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/Docs%20Check/badge.svg
:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/domdf_sphinx_theme/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/domdf_sphinx_theme/
:alt: Requirements Status
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/domdf_sphinx_theme?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/domdf_sphinx_theme
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/domdf_sphinx_theme
:target: https://pypi.org/project/domdf_sphinx_theme/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/domdf_sphinx_theme?logo=python&logoColor=white
:target: https://pypi.org/project/domdf_sphinx_theme/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/domdf_sphinx_theme
:target: https://pypi.org/project/domdf_sphinx_theme/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/domdf_sphinx_theme
:target: https://pypi.org/project/domdf_sphinx_theme/
:alt: PyPI - Wheel
.. |license| image:: https://img.shields.io/github/license/domdfcoding/domdf_sphinx_theme
:target: https://github.com/domdfcoding/domdf_sphinx_theme/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/domdf_sphinx_theme
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/domdf_sphinx_theme/v24.1.1
:target: https://github.com/domdfcoding/domdf_sphinx_theme/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/domdf_sphinx_theme
:target: https://github.com/domdfcoding/domdf_sphinx_theme/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/domdf_sphinx_theme
:target: https://pypi.org/project/domdf_sphinx_theme/
:alt: PyPI - Downloads
.. end shields
Changes include:
* Wider body by default.
* Extra spacing in lists.
* Some JavaScript trickery to fix the ReadTheDocs versions menu.
Installation
--------------
.. start installation
``domdf_sphinx_theme`` can be installed from PyPI.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install domdf_sphinx_theme
.. end installation