Merge branch 'master' into dark-theme

Author: septatrix

.readthedocs.yml

@@ -0,0 +1,15 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Project page: https://readthedocs.org/projects/python-docs-theme-previews/
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+
+  commands:
+    - git clone --depth=1 https://github.com/python/cpython
+    - make html CPYTHON_PATH=cpython
+    - mv cpython/Doc/build _readthedocs

CONTRIBUTING.rst

@@ -13,3 +13,12 @@
 - bump version (YYYY.MM.dev) in setup.py and python_docs_theme/theme.conf
 - Commit this last bump.
 - push and push the tag (``git push && git push --tags``)
+
+# Makefile usage
+
+This project includes a simple Makefile for syncing changes to the theme with
+the main CPython repository. Run ``make help`` for details on available rules.
+
+There is one configurable variable, ``CPYTHON_PATH``, which should be the path
+to the CPython repository on your machine. By default, it points to
+``../cpython``.

MANIFEST.in

@@ -0,0 +1,29 @@
+# You can set these variables from the command line.
+CPYTHON_PATH = ../cpython
+PYTHON       = python3
+PACKAGE_ABS_PATH = $(shell pwd)/$(shell find dist/python-docs-theme-*.tar.gz)
+
+
+.PHONY: help
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  venv       to create a venv with necessary tools at $(CPYTHON_PATH)/Doc/venv"
+	@echo "  html       to make standalone CPython HTML files"
+	@echo "  htmlview   to open the index page built by the html target in your browser"
+
+.PHONY: venv
+venv:
+	$(PYTHON) -m pip install build
+	$(PYTHON) -m build
+	cd $(CPYTHON_PATH)/Doc \
+		&& make venv \
+		&& ./venv/bin/pip install $(PACKAGE_ABS_PATH)
+
+.PHONY: html
+html: venv
+	cd $(CPYTHON_PATH)/Doc && \
+		make html
+
+.PHONY: htmlview
+htmlview: html
+	$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('$(CPYTHON_PATH)/Doc/build/html/index.html'))"

Makefile

@@ -1,7 +1,48 @@
 [build-system]
-requires = [
-    "setuptools>=42",
-    "wheel"
+requires = ["flit_core>=3.7"]
+build-backend = "flit_core.buildapi"
+
+# project metadata
+[project]
+name = "python-docs-theme"
+version = "2022.1"
+description = "The Sphinx theme for the CPython docs and related projects"
+readme = "README.rst"
+urls.Code = "https://github.com/python/python-docs-theme"
+urls.Download = "https://pypi.org/project/python-docs-theme/"
+urls.Homepage = "https://github.com/python/python-docs-theme/"
+urls."Issue tracker" = "https://github.com/python/python-docs-theme/issues"
+license.text = "PSF-2.0"
+requires-python = ">=3.8"
+
+# Classifiers list: https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Sphinx :: Theme",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Python Software Foundation License",
+    "Operating System :: OS Independent",
+    "Topic :: Documentation",
+    "Topic :: Software Development :: Documentation",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
 ]
-build-backend = "setuptools.build_meta"
 
+[[project.authors]]
+name = "PyPA"
+email = "[email protected]"
+
+[project.entry-points."sphinx.html_themes"]
+python_docs_theme = 'python_docs_theme'
+
+[tool.flit.module]
+name = "python_docs_theme"
+
+[tool.flit.sdist]
+include = [
+    "python_docs_theme/",
+]

pyproject.toml

@@ -186,7 +186,7 @@ div.body a:hover {
 }
 
 tt, code, pre {
-    font-family: "monospace", monospace;
+    font-family: ui-monospace, "Cascadia Mono", "Segoe UI Mono", "Liberation Mono", Menlo, Monaco, Consolas, monospace;
     font-size: 96.5%;
 }
 
@@ -238,7 +238,6 @@ table.footnote td {
 
 div.footer {
     line-height: 150%;
-    margin-top: -2em;
     text-align: right;
     width: auto;
     margin-right: 10px;
@@ -257,7 +256,7 @@ div.footer a:hover {
 }
 
 dl > dt span ~ em {
-    font-family: "monospace", monospace;
+    font-family: ui-monospace, "Cascadia Mono", "Segoe UI Mono", "Liberation Mono", Menlo, Monaco, Consolas, monospace;
 }
 
 .toctree-wrapper ul {
@@ -268,6 +267,18 @@ dl > dt span ~ em {
     margin-left: .5em;
 }
 
+div.genindex-jumpbox,
+div.genindex-jumpbox > p {
+    display: inline-flex;
+    flex-wrap: wrap;
+}
+
+div.genindex-jumpbox a {
+    margin: 0 5px;
+    min-width: 30px;
+    text-align: center;
+}
+
 @media (max-width: 1023px) {
     /* Body layout */
     div.body {
@@ -304,6 +315,9 @@ dl > dt span ~ em {
     html {
         scroll-padding-top: 40px;
     }
+    body {
+        margin-top: 40px;
+    }
 
     /* Top navigation bar */
     .mobile-nav {
@@ -487,7 +501,6 @@ dl > dt span ~ em {
         width: 100%;
     }
     .document {
-        padding-top: 40px;
         position: relative;
         z-index: 0;
     }
@@ -507,3 +520,9 @@ dl > dt span ~ em {
         flex: auto;
     }
 }
+
+@media (min-width: 1024px) {
+    div.footer {
+        margin-top: -2em;
+    }
+}