python-docs-theme 2024.1__tar.gz → 2024.3__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 (17) hide show
  1. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/PKG-INFO +9 -2
  2. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/README.rst +8 -1
  3. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/pyproject.toml +5 -1
  4. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/pydoctheme.css +38 -4
  5. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/theme.conf +2 -2
  6. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/LICENSE +0 -0
  7. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/__init__.py +0 -0
  8. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/footerdonate.html +0 -0
  9. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/layout.html +0 -0
  10. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/copybutton.js +0 -0
  11. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/menu.js +0 -0
  12. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/py.png +0 -0
  13. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/py.svg +0 -0
  14. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/pydoctheme_dark.css +0 -0
  15. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/search-focus.js +0 -0
  16. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/sidebar.js_t +0 -0
  17. {python_docs_theme-2024.1 → python_docs_theme-2024.3}/python_docs_theme/static/themetoggle.js +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: python-docs-theme
3
- Version: 2024.1
3
+ Version: 2024.3
4
4
  Summary: The Sphinx theme for the CPython docs and related projects
5
5
  Author-email: PyPA <distutils-sig@python.org>
6
6
  Requires-Python: >=3.8
@@ -48,5 +48,12 @@ To use this theme, add the following to ``conf.py``:
48
48
 
49
49
  - ``html_theme = 'python_docs_theme'``
50
50
 
51
- - ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars
51
+ - ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
52
+
53
+ Preview
54
+ -------
55
+
56
+ See a demo of the CPython docs using this theme:
57
+
58
+ - https://python-docs-theme-previews.readthedocs.io
52
59
 
@@ -21,4 +21,11 @@ To use this theme, add the following to ``conf.py``:
21
21
 
22
22
  - ``html_theme = 'python_docs_theme'``
23
23
 
24
- - ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars
24
+ - ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
25
+
26
+ Preview
27
+ -------
28
+
29
+ See a demo of the CPython docs using this theme:
30
+
31
+ - https://python-docs-theme-previews.readthedocs.io
@@ -6,7 +6,7 @@ requires = [
6
6
 
7
7
  [project]
8
8
  name = "python-docs-theme"
9
- version = "2024.1"
9
+ version = "2024.3"
10
10
  description = "The Sphinx theme for the CPython docs and related projects"
11
11
  readme = "README.rst"
12
12
  license.file = "LICENSE"
@@ -43,3 +43,7 @@ name = "python_docs_theme"
43
43
  include = [
44
44
  "python_docs_theme/",
45
45
  ]
46
+
47
+ [tool.isort]
48
+ add_imports = "from __future__ import annotations"
49
+ profile = "black"
@@ -29,11 +29,42 @@ pre {
29
29
  color: inherit;
30
30
  }
31
31
 
32
+ /* Add underlines to links */
32
33
  a[href] {
33
34
  text-decoration: underline 1px;
35
+ }
36
+
37
+ /* Increase the underline offset for code to avoid obscuring underscores */
38
+ a[href]:has(> code) {
34
39
  text-underline-offset: 0.25em;
35
40
  }
36
41
 
42
+ /* No underline for navigation */
43
+ a.headerlink,
44
+ div.genindex-jumpbox a,
45
+ div.modindex-jumpbox a,
46
+ div#search-results a,
47
+ div.sphinxsidebar a,
48
+ div.toctree-wrapper a,
49
+ div[role=navigation] a,
50
+ table.contentstable a,
51
+ table.indextable a {
52
+ text-decoration: none;
53
+ }
54
+
55
+ /* Except when hovered */
56
+ div.genindex-jumpbox a:hover,
57
+ div.modindex-jumpbox a:hover,
58
+ div#search-results a:hover,
59
+ div.sphinxsidebar a:hover,
60
+ div.toctree-wrapper a:hover,
61
+ div[role=navigation] a:hover,
62
+ table.contentstable a:hover,
63
+ table.indextable a:hover {
64
+ text-decoration: underline;
65
+ text-underline-offset: auto;
66
+ }
67
+
37
68
  body {
38
69
  margin-left: 1em;
39
70
  margin-right: 1em;
@@ -139,7 +170,7 @@ div.sphinxsidebar a:hover {
139
170
  form.inline-search input,
140
171
  div.sphinxsidebar input,
141
172
  div.related input {
142
- font-family: 'Lucida Grande', Arial, sans-serif;
173
+ font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif;
143
174
  border: 1px solid #999999;
144
175
  font-size: smaller;
145
176
  border-radius: 3px;
@@ -227,7 +258,7 @@ div.body a:hover {
227
258
  }
228
259
 
229
260
  tt, code, pre {
230
- font-family: ui-monospace, "Cascadia Mono", "Segoe UI Mono", "Liberation Mono", Menlo, Monaco, Consolas, monospace;
261
+ font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace;
231
262
  font-size: 96.5%;
232
263
  }
233
264
 
@@ -284,6 +315,10 @@ div.footer {
284
315
  margin-right: 10px;
285
316
  }
286
317
 
318
+ div.footer a {
319
+ text-underline-offset: auto;
320
+ }
321
+
287
322
  div.footer a:hover {
288
323
  color: #0095c4;
289
324
  }
@@ -326,8 +361,7 @@ div.genindex-jumpbox a {
326
361
  position: absolute;
327
362
  top: 0;
328
363
  right: 0;
329
- text-size: 75%;
330
- font-family: monospace;
364
+ font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace;
331
365
  padding-left: 0.2em;
332
366
  padding-right: 0.2em;
333
367
  border-radius: 0 3px 0 0;
@@ -5,8 +5,8 @@ pygments_style = default
5
5
  pygments_dark_style = monokai
6
6
 
7
7
  [options]
8
- bodyfont = 'Lucida Grande', Arial, sans-serif
9
- headfont = 'Lucida Grande', Arial, sans-serif
8
+ bodyfont = -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif
9
+ headfont = -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif
10
10
  footerbgcolor = white
11
11
  footertextcolor = #555555
12
12
  relbarbgcolor = white