sphinx-daisyui 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. sphinx_daisyui-0.1.0/.gitignore +40 -0
  2. sphinx_daisyui-0.1.0/LICENSE +21 -0
  3. sphinx_daisyui-0.1.0/PKG-INFO +113 -0
  4. sphinx_daisyui-0.1.0/README.md +82 -0
  5. sphinx_daisyui-0.1.0/assets/content.css +2051 -0
  6. sphinx_daisyui-0.1.0/assets/frame.css +295 -0
  7. sphinx_daisyui-0.1.0/assets/theme.css +16 -0
  8. sphinx_daisyui-0.1.0/assets/tokens.css +8 -0
  9. sphinx_daisyui-0.1.0/package-lock.json +1178 -0
  10. sphinx_daisyui-0.1.0/package.json +18 -0
  11. sphinx_daisyui-0.1.0/pyproject.toml +117 -0
  12. sphinx_daisyui-0.1.0/src/sphinx_daisyui/__init__.py +44 -0
  13. sphinx_daisyui-0.1.0/src/sphinx_daisyui/body.py +249 -0
  14. sphinx_daisyui-0.1.0/src/sphinx_daisyui/brand.py +61 -0
  15. sphinx_daisyui-0.1.0/src/sphinx_daisyui/events.py +202 -0
  16. sphinx_daisyui-0.1.0/src/sphinx_daisyui/icons.json +1 -0
  17. sphinx_daisyui-0.1.0/src/sphinx_daisyui/icons.py +42 -0
  18. sphinx_daisyui-0.1.0/src/sphinx_daisyui/layout.py +145 -0
  19. sphinx_daisyui-0.1.0/src/sphinx_daisyui/links.py +235 -0
  20. sphinx_daisyui-0.1.0/src/sphinx_daisyui/locale/sphinx.pot +191 -0
  21. sphinx_daisyui-0.1.0/src/sphinx_daisyui/modes.py +101 -0
  22. sphinx_daisyui-0.1.0/src/sphinx_daisyui/navigation.py +468 -0
  23. sphinx_daisyui-0.1.0/src/sphinx_daisyui/options.py +195 -0
  24. sphinx_daisyui-0.1.0/src/sphinx_daisyui/py.typed +0 -0
  25. sphinx_daisyui-0.1.0/src/sphinx_daisyui/pygments.py +115 -0
  26. sphinx_daisyui-0.1.0/src/sphinx_daisyui/search.py +40 -0
  27. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/announcement.html +7 -0
  28. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/breadcrumbs.html +11 -0
  29. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/copyright.html +6 -0
  30. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/edit-this-page.html +4 -0
  31. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/last-updated.html +1 -0
  32. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/macros.html +29 -0
  33. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/navbar-icon-links.html +8 -0
  34. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/navbar-logo.html +8 -0
  35. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/navbar-nav.html +20 -0
  36. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/page-toc.html +6 -0
  37. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/search-button-field.html +7 -0
  38. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/search-modal.html +32 -0
  39. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/sidebar-nav.html +3 -0
  40. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/sourcelink.html +4 -0
  41. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/sphinx-version.html +1 -0
  42. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/theme-switcher.html +36 -0
  43. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/theme-version.html +1 -0
  44. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/components/version-switcher.html +13 -0
  45. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/layout.html +151 -0
  46. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/announcement.js +18 -0
  47. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/back-to-top.js +25 -0
  48. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/frame.js +70 -0
  49. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/keys.js +30 -0
  50. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/mode.js +105 -0
  51. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/navigation.js +62 -0
  52. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/page-address.js +33 -0
  53. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/page-toc.js +55 -0
  54. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/search.js +252 -0
  55. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/theme-menu.js +67 -0
  56. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/scripts/versions.js +108 -0
  57. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/static/styles/sphinx-daisyui.css +2 -0
  58. sphinx_daisyui-0.1.0/src/sphinx_daisyui/theme/daisyui/theme.toml +55 -0
  59. sphinx_daisyui-0.1.0/src/sphinx_daisyui/themes.json +1 -0
  60. sphinx_daisyui-0.1.0/src/sphinx_daisyui/versions.py +135 -0
@@ -0,0 +1,40 @@
1
+ # Temporary and binary files
2
+ *~
3
+ *.ruff_cache
4
+ *.mypy_cache
5
+ *.py[cod]
6
+ *.so
7
+ *.cfg
8
+ *.orig
9
+ *.log
10
+ *.pot
11
+ !src/sphinx_daisyui/locale/sphinx.pot
12
+ **/__pycache__
13
+ .cache/*
14
+ .*.swp
15
+
16
+ # IDEs and editors
17
+ .vscode
18
+
19
+ # Unittest and coverage
20
+ htmlcov
21
+ .coverage
22
+ .coverage.*
23
+ .tox
24
+ junit*.xml
25
+ coverage.xml
26
+ .pytest_cache/
27
+
28
+ # Environments
29
+ .env
30
+ .venv
31
+
32
+ # Release archives
33
+ dist/
34
+
35
+ # Sphinx build output
36
+ _build/
37
+
38
+ # Node, and the stylesheet compiled from assets/ when the package is built
39
+ node_modules/
40
+ src/sphinx_daisyui/theme/daisyui/static/styles/sphinx-daisyui.css
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Samuel Jennings
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,113 @@
1
+ Metadata-Version: 2.5
2
+ Name: sphinx-daisyui
3
+ Version: 0.1.0
4
+ Summary: A Sphinx theme drawn with daisyUI 5, with its own options
5
+ Project-URL: homepage, https://github.com/SamuelJennings/sphinx-daisyui
6
+ Project-URL: repository, https://github.com/SamuelJennings/sphinx-daisyui
7
+ Project-URL: documentation, https://github.com/SamuelJennings/sphinx-daisyui#readme
8
+ Project-URL: changelog, https://github.com/SamuelJennings/sphinx-daisyui/blob/main/CHANGELOG.md
9
+ Author-email: Sam <samuel.scott.jennings@gmail.com>
10
+ License-Expression: MIT
11
+ License-File: LICENSE
12
+ Keywords: daisyui,documentation,sphinx,tailwind,theme
13
+ Classifier: Development Status :: 2 - Pre-Alpha
14
+ Classifier: Framework :: Sphinx
15
+ Classifier: Framework :: Sphinx :: Theme
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: Natural Language :: English
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Programming Language :: Python :: 3.14
22
+ Classifier: Topic :: Documentation
23
+ Classifier: Topic :: Documentation :: Sphinx
24
+ Classifier: Topic :: Software Development :: Documentation
25
+ Requires-Python: >=3.11
26
+ Requires-Dist: docutils>=0.20
27
+ Requires-Dist: markupsafe>=2.1
28
+ Requires-Dist: pygments>=2.17
29
+ Requires-Dist: sphinx>=7.4
30
+ Description-Content-Type: text/markdown
31
+
32
+ # sphinx-daisyui
33
+
34
+ [![Tests](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/tests.yml/badge.svg)](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/tests.yml)
35
+ [![Build](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/build.yml/badge.svg)](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/build.yml)
36
+ [![Publish](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/publish.yml/badge.svg)](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/publish.yml)
37
+ [![Coverage](https://codecov.io/gh/SamuelJennings/sphinx-daisyui/branch/main/graph/badge.svg)](https://codecov.io/gh/SamuelJennings/sphinx-daisyui)
38
+ [![PyPI](https://img.shields.io/pypi/v/sphinx-daisyui)](https://pypi.org/project/sphinx-daisyui/)
39
+ [![Development status](https://img.shields.io/pypi/status/sphinx-daisyui)](https://pypi.org/project/sphinx-daisyui/)
40
+ [![Python](https://img.shields.io/pypi/pyversions/sphinx-daisyui)](https://pypi.org/project/sphinx-daisyui/)
41
+ [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
42
+ [![Licence](https://img.shields.io/github/license/SamuelJennings/sphinx-daisyui)](https://github.com/SamuelJennings/sphinx-daisyui/blob/main/LICENSE)
43
+
44
+ A [Sphinx](https://www.sphinx-doc.org/) theme drawn with [daisyUI](https://daisyui.com/) 5 and
45
+ Tailwind CSS 4. It has its own `html_theme_options`, named and shaped after those of
46
+ [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/) where it has the same setting.
47
+ A site coming from [Furo](https://pradyunsg.me/furo/) or pydata-sphinx-theme reconfigures, and
48
+ the layout option can give it a page arranged like either.
49
+
50
+ ## Why
51
+
52
+ Most Sphinx themes are drawn with Bootstrap or with a stylesheet of their own. daisyUI gives a
53
+ component library and 35 ready-made colour themes on Tailwind's tokens, each with a light and a
54
+ dark variant. A theme built on it gets every one of those themes for free, and a site that
55
+ already uses daisyUI elsewhere gets documentation that looks like the rest of it.
56
+
57
+ ## Status
58
+
59
+ Pre-alpha. The package registers the `daisyui` theme and ships its compiled stylesheet. The
60
+ layout, navigation, search and option handling are being built.
61
+
62
+ ## Usage
63
+
64
+ ```bash
65
+ pip install sphinx-daisyui
66
+ ```
67
+
68
+ ```python
69
+ # conf.py
70
+ html_theme = "daisyui"
71
+ ```
72
+
73
+ ## Scope & philosophy
74
+
75
+ **What it is**
76
+
77
+ - A Sphinx HTML theme drawn with daisyUI 5.
78
+ - A theme with its own options, which follow pydata-sphinx-theme's names and shapes where it has
79
+ the same setting. A site coming from Furo or pydata-sphinx-theme reconfigures.
80
+ - Every colour comes from a daisyUI token, so any daisyUI theme works, in light and dark.
81
+ - The page layout can be rearranged with one option, and each part of the page is filled from a
82
+ list of components.
83
+
84
+ **What it is not**
85
+
86
+ - A collection of new directives or roles. It styles what Sphinx and common extensions such as
87
+ sphinx-design already write.
88
+ - A Bootstrap compatibility layer. Markup written for Bootstrap is not restyled.
89
+ - Something that needs Node to use. The compiled stylesheet ships in the package. A site
90
+ changes the look with daisyUI's CSS variables in its own static files.
91
+
92
+ **When two goals conflict**, one name and one shape for each option wins over resemblance to
93
+ another theme.
94
+
95
+ ### Prior art
96
+
97
+ - [Furo](https://github.com/pradyunsg/furo) and
98
+ [pydata-sphinx-theme](https://github.com/pydata/pydata-sphinx-theme) are the themes most
99
+ modern Sphinx sites use. pydata-sphinx-theme is drawn with Bootstrap 5. Furo has a stylesheet of
100
+ its own. This theme borrows their page layout and the names of
101
+ pydata-sphinx-theme's options, and has options of its own.
102
+ - [Shibuya](https://github.com/lepture/shibuya) and
103
+ [sphinxawesome-theme](https://github.com/kai687/sphinxawesome-theme) are modern themes with their
104
+ own options. sphinxawesome-theme is built on Tailwind.
105
+ - None of them uses daisyUI.
106
+
107
+ ## Contributing
108
+
109
+ See [CONTRIBUTING.md](https://github.com/SamuelJennings/sphinx-daisyui/blob/main/CONTRIBUTING.md).
110
+
111
+ ## License
112
+
113
+ MIT. See [LICENSE](https://github.com/SamuelJennings/sphinx-daisyui/blob/main/LICENSE).
@@ -0,0 +1,82 @@
1
+ # sphinx-daisyui
2
+
3
+ [![Tests](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/tests.yml/badge.svg)](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/tests.yml)
4
+ [![Build](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/build.yml/badge.svg)](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/build.yml)
5
+ [![Publish](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/publish.yml/badge.svg)](https://github.com/SamuelJennings/sphinx-daisyui/actions/workflows/publish.yml)
6
+ [![Coverage](https://codecov.io/gh/SamuelJennings/sphinx-daisyui/branch/main/graph/badge.svg)](https://codecov.io/gh/SamuelJennings/sphinx-daisyui)
7
+ [![PyPI](https://img.shields.io/pypi/v/sphinx-daisyui)](https://pypi.org/project/sphinx-daisyui/)
8
+ [![Development status](https://img.shields.io/pypi/status/sphinx-daisyui)](https://pypi.org/project/sphinx-daisyui/)
9
+ [![Python](https://img.shields.io/pypi/pyversions/sphinx-daisyui)](https://pypi.org/project/sphinx-daisyui/)
10
+ [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
11
+ [![Licence](https://img.shields.io/github/license/SamuelJennings/sphinx-daisyui)](https://github.com/SamuelJennings/sphinx-daisyui/blob/main/LICENSE)
12
+
13
+ A [Sphinx](https://www.sphinx-doc.org/) theme drawn with [daisyUI](https://daisyui.com/) 5 and
14
+ Tailwind CSS 4. It has its own `html_theme_options`, named and shaped after those of
15
+ [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/) where it has the same setting.
16
+ A site coming from [Furo](https://pradyunsg.me/furo/) or pydata-sphinx-theme reconfigures, and
17
+ the layout option can give it a page arranged like either.
18
+
19
+ ## Why
20
+
21
+ Most Sphinx themes are drawn with Bootstrap or with a stylesheet of their own. daisyUI gives a
22
+ component library and 35 ready-made colour themes on Tailwind's tokens, each with a light and a
23
+ dark variant. A theme built on it gets every one of those themes for free, and a site that
24
+ already uses daisyUI elsewhere gets documentation that looks like the rest of it.
25
+
26
+ ## Status
27
+
28
+ Pre-alpha. The package registers the `daisyui` theme and ships its compiled stylesheet. The
29
+ layout, navigation, search and option handling are being built.
30
+
31
+ ## Usage
32
+
33
+ ```bash
34
+ pip install sphinx-daisyui
35
+ ```
36
+
37
+ ```python
38
+ # conf.py
39
+ html_theme = "daisyui"
40
+ ```
41
+
42
+ ## Scope & philosophy
43
+
44
+ **What it is**
45
+
46
+ - A Sphinx HTML theme drawn with daisyUI 5.
47
+ - A theme with its own options, which follow pydata-sphinx-theme's names and shapes where it has
48
+ the same setting. A site coming from Furo or pydata-sphinx-theme reconfigures.
49
+ - Every colour comes from a daisyUI token, so any daisyUI theme works, in light and dark.
50
+ - The page layout can be rearranged with one option, and each part of the page is filled from a
51
+ list of components.
52
+
53
+ **What it is not**
54
+
55
+ - A collection of new directives or roles. It styles what Sphinx and common extensions such as
56
+ sphinx-design already write.
57
+ - A Bootstrap compatibility layer. Markup written for Bootstrap is not restyled.
58
+ - Something that needs Node to use. The compiled stylesheet ships in the package. A site
59
+ changes the look with daisyUI's CSS variables in its own static files.
60
+
61
+ **When two goals conflict**, one name and one shape for each option wins over resemblance to
62
+ another theme.
63
+
64
+ ### Prior art
65
+
66
+ - [Furo](https://github.com/pradyunsg/furo) and
67
+ [pydata-sphinx-theme](https://github.com/pydata/pydata-sphinx-theme) are the themes most
68
+ modern Sphinx sites use. pydata-sphinx-theme is drawn with Bootstrap 5. Furo has a stylesheet of
69
+ its own. This theme borrows their page layout and the names of
70
+ pydata-sphinx-theme's options, and has options of its own.
71
+ - [Shibuya](https://github.com/lepture/shibuya) and
72
+ [sphinxawesome-theme](https://github.com/kai687/sphinxawesome-theme) are modern themes with their
73
+ own options. sphinxawesome-theme is built on Tailwind.
74
+ - None of them uses daisyUI.
75
+
76
+ ## Contributing
77
+
78
+ See [CONTRIBUTING.md](https://github.com/SamuelJennings/sphinx-daisyui/blob/main/CONTRIBUTING.md).
79
+
80
+ ## License
81
+
82
+ MIT. See [LICENSE](https://github.com/SamuelJennings/sphinx-daisyui/blob/main/LICENSE).