###################
domdf_sphinx_theme
###################
.. start short_desc
**Customised 'sphinx_rtd_theme' used by my Python projects.**
.. end short_desc
Based on `sphinx_rtd_theme <https://github.com/readthedocs/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
Raw data
{
"_id": null,
"home_page": "https://github.com/domdfcoding/domdf_sphinx_theme",
"name": "domdf-sphinx-theme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "documentation, sphinx, sphinx-theme",
"author": null,
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/85/4e/6ef72f1668f3b1d98465dee9e29a30fee24cc534142821bd970ffec2445b/domdf_sphinx_theme-24.1.1.tar.gz",
"platform": "Windows",
"description": "\n###################\ndomdf_sphinx_theme\n###################\n\n.. start short_desc\n\n**Customised 'sphinx_rtd_theme' used by my Python projects.**\n\n.. end short_desc\n\nBased on `sphinx_rtd_theme <https://github.com/readthedocs/sphinx_rtd_theme>`_ by ReadTheDocs.\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/domdf-sphinx-theme/latest?logo=read-the-docs\n\t:target: https://domdf-sphinx-theme.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/Linux/badge.svg\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/Windows/badge.svg\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/macOS/badge.svg\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/Flake8/badge.svg\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/domdfcoding/domdf_sphinx_theme/workflows/mypy/badge.svg\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/domdf_sphinx_theme/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/domdf_sphinx_theme/\n\t:alt: Requirements Status\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/domdf_sphinx_theme?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/domdfcoding/domdf_sphinx_theme\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/domdf_sphinx_theme\n\t:target: https://pypi.org/project/domdf_sphinx_theme/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/domdf_sphinx_theme?logo=python&logoColor=white\n\t:target: https://pypi.org/project/domdf_sphinx_theme/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/domdf_sphinx_theme\n\t:target: https://pypi.org/project/domdf_sphinx_theme/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/domdf_sphinx_theme\n\t:target: https://pypi.org/project/domdf_sphinx_theme/\n\t:alt: PyPI - Wheel\n\n.. |license| image:: https://img.shields.io/github/license/domdfcoding/domdf_sphinx_theme\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/domdf_sphinx_theme\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/domdf_sphinx_theme/v24.1.1\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/domdf_sphinx_theme\n\t:target: https://github.com/domdfcoding/domdf_sphinx_theme/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2024\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/domdf_sphinx_theme\n\t:target: https://pypi.org/project/domdf_sphinx_theme/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nChanges include:\n\n* Wider body by default.\n* Extra spacing in lists.\n* Some JavaScript trickery to fix the ReadTheDocs versions menu.\n\n\nInstallation\n--------------\n\n.. start installation\n\n``domdf_sphinx_theme`` can be installed from PyPI.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install domdf_sphinx_theme\n\n.. end installation\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Customised 'sphinx_rtd_theme' used by my Python projects.",
"version": "24.1.1",
"project_urls": {
"Documentation": "https://domdf-sphinx-theme.readthedocs.io/en/latest",
"Homepage": "https://github.com/domdfcoding/domdf_sphinx_theme",
"Issue Tracker": "https://github.com/domdfcoding/domdf_sphinx_theme/issues",
"Source Code": "https://github.com/domdfcoding/domdf_sphinx_theme"
},
"split_keywords": [
"documentation",
" sphinx",
" sphinx-theme"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8dfbb95811b274845cc3ca87c96b79640e19e299b109d38e536f7a97f726b7c4",
"md5": "f6a48d5e2fafc14d73c39f299750bbbc",
"sha256": "70a8deed6c850a9f86354227ccf9ba946b51e2558109f35b46f5ed72dcfc0e42"
},
"downloads": -1,
"filename": "domdf_sphinx_theme-24.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6a48d5e2fafc14d73c39f299750bbbc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35251,
"upload_time": "2024-07-03T11:04:15",
"upload_time_iso_8601": "2024-07-03T11:04:15.946239Z",
"url": "https://files.pythonhosted.org/packages/8d/fb/b95811b274845cc3ca87c96b79640e19e299b109d38e536f7a97f726b7c4/domdf_sphinx_theme-24.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "854e6ef72f1668f3b1d98465dee9e29a30fee24cc534142821bd970ffec2445b",
"md5": "13f98e1397a0b0a4dc3b1a1d263b8cb5",
"sha256": "42cc057844dc7ca2aacb83a40fdee64b3c9a8e3a33e34903ac5803b7de924c1d"
},
"downloads": -1,
"filename": "domdf_sphinx_theme-24.1.1.tar.gz",
"has_sig": false,
"md5_digest": "13f98e1397a0b0a4dc3b1a1d263b8cb5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 33667,
"upload_time": "2024-07-03T11:04:17",
"upload_time_iso_8601": "2024-07-03T11:04:17.993479Z",
"url": "https://files.pythonhosted.org/packages/85/4e/6ef72f1668f3b1d98465dee9e29a30fee24cc534142821bd970ffec2445b/domdf_sphinx_theme-24.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-03 11:04:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "domdfcoding",
"github_project": "domdf_sphinx_theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "domdf-sphinx-theme"
}
JSON
