From 94e8c30f9def28402469bf2967ea7ae5a4dc1542 Mon Sep 17 00:00:00 2001 From: Scoder12 <34356756+Scoder12@users.noreply.github.com> Date: Mon, 27 Jul 2020 15:57:58 -0700 Subject: [PATCH] Switch to readthedocs theme with custom darktheme --- docs/_static/css/darktheme.css | 14 ++++++++++++++ docs/conf.py | 14 +++++++++++--- poetry.lock | 17 +---------------- pyproject.toml | 1 - 4 files changed, 26 insertions(+), 20 deletions(-) create mode 100644 docs/_static/css/darktheme.css diff --git a/docs/_static/css/darktheme.css b/docs/_static/css/darktheme.css new file mode 100644 index 0000000..d9e0033 --- /dev/null +++ b/docs/_static/css/darktheme.css @@ -0,0 +1,14 @@ +/* Body dark theme */ +body { + background: #333; + color: #fff; +} + +.wy-nav-content { + background: #444; +} + +/* Use original color inside of code blocks */ +.highlight { + color: #404040; +} diff --git a/docs/conf.py b/docs/conf.py index af5b028..a575cc3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,4 @@ -# Configuration file for the Sphinx documentation builder. +"""Configuration file for the Sphinx documentation builder.""" # # This file only contains a selection of the most common options. For a full # list see the documentation: @@ -32,7 +32,12 @@ release = "1.3.0" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_autodoc_typehints"] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.napoleon", + "sphinx_autodoc_typehints", + "sphinx_rtd_theme", +] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -48,9 +53,12 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "conf.py"] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "groundwork" +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] + +# Custom css +html_css_files = ["css/darktheme.css"] diff --git a/poetry.lock b/poetry.lock index 6252b50..87282bc 100644 --- a/poetry.lock +++ b/poetry.lock @@ -240,17 +240,6 @@ version = "3.1.7" [package.dependencies] gitdb = ">=4.0.1,<5" -[[package]] -category = "dev" -description = "Sphinx theme for groundwork projects (Based on flask_theme)" -name = "groundwork-sphinx-theme" -optional = false -python-versions = "*" -version = "1.1.1" - -[package.dependencies] -Sphinx = ">=1.6.1" - [[package]] category = "main" description = "Internationalized Domain Names in Applications (IDNA)" @@ -614,7 +603,7 @@ secure = ["certifi", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "pyOpenSSL (>=0 socks = ["PySocks (>=1.5.6,<1.5.7 || >1.5.7,<2.0)"] [metadata] -content-hash = "b4fbea4fefd4fd185efb94fc94d08c25d92e9b903e97c4e735c8a88c36affa82" +content-hash = "7388d8240a2817695e502fb845922da8df699d77d143693ffe3285eca1df3495" python-versions = "^3.8" [metadata.files] @@ -704,10 +693,6 @@ gitpython = [ {file = "GitPython-3.1.7-py3-none-any.whl", hash = "sha256:fa3b92da728a457dd75d62bb5f3eb2816d99a7fe6c67398e260637a40e3fafb5"}, {file = "GitPython-3.1.7.tar.gz", hash = "sha256:2db287d71a284e22e5c2846042d0602465c7434d910406990d5b74df4afb0858"}, ] -groundwork-sphinx-theme = [ - {file = "groundwork-sphinx-theme-1.1.1.tar.gz", hash = "sha256:5f1217bf34daba5fcd93e8a2a04ef5a6c2b144ec43754aec7ce14de501e23fe4"}, - {file = "groundwork_sphinx_theme-1.1.1-py2.py3-none-any.whl", hash = "sha256:b4796989ce3cd6d5b5a3c7ebe52a8c9cf848110e9f12c2c88e2b3c0e4e8f0e24"}, -] idna = [ {file = "idna-2.10-py2.py3-none-any.whl", hash = "sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0"}, {file = "idna-2.10.tar.gz", hash = "sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6"}, diff --git a/pyproject.toml b/pyproject.toml index ec9f6c0..bf6bc58 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -22,7 +22,6 @@ flake8-annotations = "^2.3.0" flake8-docstrings = "^1.5.0" sphinx = "^3.1.2" sphinx-autodoc-typehints = "^1.11.0" -groundwork-sphinx-theme = "^1.1.1" sphinx-rtd-theme = "^0.5.0" [build-system]