diff --git a/docs/conf.py b/docs/conf.py index 8ff037bcdf..212ed270ad 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,7 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "furo" +html_theme = "sphinx_material" # -- Extensions -------------------------------------------------------------- diff --git a/poetry.lock b/poetry.lock index 4fb685d2ab..86d10a6cc5 100644 --- a/poetry.lock +++ b/poetry.lock @@ -410,6 +410,17 @@ tomli = {version = "*", optional = true, markers = "python_full_version <= \"3.1 [package.extras] toml = ["tomli"] +[[package]] +name = "css-html-js-minify" +version = "2.5.5" +description = "CSS HTML JS Minifier" +optional = false +python-versions = ">=3.6" +files = [ + {file = "css-html-js-minify-2.5.5.zip", hash = "sha256:4a9f11f7e0496f5284d12111f3ba4ff5ff2023d12f15d195c9c48bd97013746c"}, + {file = "css_html_js_minify-2.5.5-py2.py3-none-any.whl", hash = "sha256:3da9d35ac0db8ca648c1b543e0e801d7ca0bab9e6bfd8418fee59d5ae001727a"}, +] + [[package]] name = "cycler" version = "0.11.0" @@ -1924,6 +1935,24 @@ files = [ pyasn1 = ">=0.3.7" pyasn1_modules = ">=0.1.5" +[[package]] +name = "python-slugify" +version = "8.0.4" +description = "A Python slugify application that also handles Unicode" +optional = false +python-versions = ">=3.7" +files = [ + {file = "python-slugify-8.0.4.tar.gz", hash = "sha256:59202371d1d05b54a9e7720c5e038f928f45daaffe41dd10822f3907b937c856"}, + {file = "python_slugify-8.0.4-py2.py3-none-any.whl", hash = "sha256:276540b79961052b66b7d116620b36518847f52d5fd9e3a70164fc8c50faa6b8"}, +] + +[package.dependencies] +text-unidecode = ">=1.3" +Unidecode = {version = ">=1.1.1", optional = true, markers = "extra == \"unidecode\""} + +[package.extras] +unidecode = ["Unidecode (>=1.1.1)"] + [[package]] name = "pytz" version = "2023.3.post1" @@ -2208,6 +2237,27 @@ sphinx = ">=4.0" [package.extras] docs = ["furo", "ipython", "myst-parser", "sphinx-copybutton", "sphinx-inline-tabs"] +[[package]] +name = "sphinx-material" +version = "0.0.36" +description = "Material sphinx theme" +optional = false +python-versions = ">=3.6" +files = [ + {file = "sphinx_material-0.0.36-py3-none-any.whl", hash = "sha256:1d7f972cca7ebdfe135e28f18401673306d7c0d036d42c6e3d98b77394e61a60"}, + {file = "sphinx_material-0.0.36.tar.gz", hash = "sha256:eeff5f7d3dc016af32bafdf70c66e671d15c8754dbe0613dfbd629fbed912869"}, +] + +[package.dependencies] +beautifulsoup4 = "*" +css-html-js-minify = "*" +lxml = "*" +python-slugify = {version = "*", extras = ["unidecode"]} +sphinx = ">=2.0" + +[package.extras] +dev = ["black (==22.12.0)"] + [[package]] name = "sphinxcontrib-applehelp" version = "1.0.4" @@ -2308,6 +2358,17 @@ files = [ {file = "suds_py3-1.4.5.0-py3-none-any.whl", hash = "sha256:0915a7f825c80fa2f0593e040e046bcbc156dd24ba988bb9da6c6604d70155b9"}, ] +[[package]] +name = "text-unidecode" +version = "1.3" +description = "The most basic Text::Unidecode port" +optional = false +python-versions = "*" +files = [ + {file = "text-unidecode-1.3.tar.gz", hash = "sha256:bad6603bb14d279193107714b288be206cac565dfa49aa5b105294dd5c4aab93"}, + {file = "text_unidecode-1.3-py2.py3-none-any.whl", hash = "sha256:1311f10e8b895935241623731c2ba64f4c455287888b18189350b67134a822e8"}, +] + [[package]] name = "tomli" version = "2.0.1" @@ -2341,6 +2402,17 @@ files = [ {file = "typing_extensions-4.3.0.tar.gz", hash = "sha256:e6d2677a32f47fc7eb2795db1dd15c1f34eff616bcaf2cfb5e997f854fa1c4a6"}, ] +[[package]] +name = "unidecode" +version = "1.3.8" +description = "ASCII transliterations of Unicode text" +optional = false +python-versions = ">=3.5" +files = [ + {file = "Unidecode-1.3.8-py3-none-any.whl", hash = "sha256:d130a61ce6696f8148a3bd8fe779c99adeb4b870584eeb9526584e9aa091fd39"}, + {file = "Unidecode-1.3.8.tar.gz", hash = "sha256:cfdb349d46ed3873ece4586b96aa75258726e2fa8ec21d6f00a591d98806c2f4"}, +] + [[package]] name = "urllib3" version = "1.26.16" @@ -2547,4 +2619,4 @@ tango = ["PyTango"] [metadata] lock-version = "2.0" python-versions = ">=3.8,<3.11" -content-hash = "32153909850af238b4a54263fc6be10c05e73fa25c3129cb264468100bce86f9" +content-hash = "2b7b42a38e9d6a297257ad0cbf69e6fb300c00ba1960165e9432b0ba0ae78849" diff --git a/pyproject.toml b/pyproject.toml index c052a30ce9..d5f6ab7a3e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -49,6 +49,7 @@ PyTango = { version = "^9.3.6", optional = true } python-ldap = "^3.4.0" requests = "^2.31.0" colorama = "^0.4.6" +sphinx-material = "^0.0.36" [tool.poetry.dev-dependencies] pylint = "^2.15.6"