diff --git a/docs/conf.py b/docs/conf.py index 707cb2d..670818f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,5 +31,5 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] diff --git a/docs/requirements.txt b/docs/requirements.txt index 0f93ed4..01df78f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -26,7 +26,7 @@ debugpy==1.8.2 decorator==5.1.1 defusedxml==0.7.1 dill==0.3.8 -docutils==0.21.2 +docutils==0.20.1 entrypoints==0.4 exceptiongroup==1.2.2 executing==2.0.1 @@ -72,6 +72,7 @@ MarkupSafe==2.1.5 matplotlib==3.9.1 matplotlib-inline==0.1.7 mdurl==0.1.2 +-e git+https://github.com/AnotherSamWilson/miceforest.git@51896d0ff654ea809d4fe8fc6bf3868ad82077ac#egg=miceforest mistune==3.0.2 mizani==0.11.4 more-itertools==10.3.0 @@ -120,7 +121,7 @@ python-json-logger==2.0.7 pytz==2024.1 PyYAML==6.0.1 pyzmq==26.0.3 -readme_renderer==44.0 +readme_renderer==43.0 referencing==0.35.1 requests==2.32.3 requests-toolbelt==1.0.0 @@ -139,9 +140,11 @@ sniffio==1.3.1 snowballstemmer==2.2.0 soupsieve==2.5 Sphinx==7.4.7 +sphinx-rtd-theme==2.0.0 sphinxcontrib-applehelp==1.0.8 sphinxcontrib-devhelp==1.0.6 sphinxcontrib-htmlhelp==2.0.6 +sphinxcontrib-jquery==4.1 sphinxcontrib-jsmath==1.0.1 sphinxcontrib-napoleon==0.7 sphinxcontrib-qthelp==1.0.8 diff --git a/poetry.lock b/poetry.lock index f849188..958887d 100644 --- a/poetry.lock +++ b/poetry.lock @@ -805,13 +805,13 @@ profile = ["gprof2dot (>=2022.7.29)"] [[package]] name = "docutils" -version = "0.21.2" +version = "0.20.1" description = "Docutils -- Python Documentation Utilities" optional = false -python-versions = ">=3.9" +python-versions = ">=3.7" files = [ - {file = "docutils-0.21.2-py3-none-any.whl", hash = "sha256:dafca5b9e384f0e419294eb4d2ff9fa826435bf15f15b7bd45723e8ad76811b2"}, - {file = "docutils-0.21.2.tar.gz", hash = "sha256:3a6b18732edf182daa3cd12775bbb338cf5691468f91eeeb109deff6ebfa986f"}, + {file = "docutils-0.20.1-py3-none-any.whl", hash = "sha256:96f387a2c5562db4476f09f13bbab2192e764cac08ebbf3a34a95d9b1e4a59d6"}, + {file = "docutils-0.20.1.tar.gz", hash = "sha256:f08a4e276c3a1583a86dce3e34aba3fe04d02bba2dd51ed16106244e8a923e3b"}, ] [[package]] @@ -3055,17 +3055,17 @@ cffi = {version = "*", markers = "implementation_name == \"pypy\""} [[package]] name = "readme-renderer" -version = "44.0" +version = "43.0" description = "readme_renderer is a library for rendering readme descriptions for Warehouse" optional = false -python-versions = ">=3.9" +python-versions = ">=3.8" files = [ - {file = "readme_renderer-44.0-py3-none-any.whl", hash = "sha256:2fbca89b81a08526aadf1357a8c2ae889ec05fb03f5da67f9769c9a592166151"}, - {file = "readme_renderer-44.0.tar.gz", hash = "sha256:8712034eabbfa6805cacf1402b4eeb2a73028f72d1166d6f5cb7f9c047c5d1e1"}, + {file = "readme_renderer-43.0-py3-none-any.whl", hash = "sha256:19db308d86ecd60e5affa3b2a98f017af384678c63c88e5d4556a380e674f3f9"}, + {file = "readme_renderer-43.0.tar.gz", hash = "sha256:1818dd28140813509eeed8d62687f7cd4f7bad90d4db586001c5dc09d4fde311"}, ] [package.dependencies] -docutils = ">=0.21.2" +docutils = ">=0.13.1" nh3 = ">=0.2.14" Pygments = ">=2.5.1" @@ -3509,6 +3509,25 @@ docs = ["sphinxcontrib-websupport"] lint = ["flake8 (>=6.0)", "importlib-metadata (>=6.0)", "mypy (==1.10.1)", "pytest (>=6.0)", "ruff (==0.5.2)", "sphinx-lint (>=0.9)", "tomli (>=2)", "types-docutils (==0.21.0.20240711)", "types-requests (>=2.30.0)"] test = ["cython (>=3.0)", "defusedxml (>=0.7.1)", "pytest (>=8.0)", "setuptools (>=70.0)", "typing_extensions (>=4.9)"] +[[package]] +name = "sphinx-rtd-theme" +version = "2.0.0" +description = "Read the Docs theme for Sphinx" +optional = false +python-versions = ">=3.6" +files = [ + {file = "sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl", hash = "sha256:ec93d0856dc280cf3aee9a4c9807c60e027c7f7b461b77aeffed682e68f0e586"}, + {file = "sphinx_rtd_theme-2.0.0.tar.gz", hash = "sha256:bd5d7b80622406762073a04ef8fadc5f9151261563d47027de09910ce03afe6b"}, +] + +[package.dependencies] +docutils = "<0.21" +sphinx = ">=5,<8" +sphinxcontrib-jquery = ">=4,<5" + +[package.extras] +dev = ["bump2version", "sphinxcontrib-httpdomain", "transifex-client", "wheel"] + [[package]] name = "sphinxcontrib-applehelp" version = "1.0.8" @@ -3557,6 +3576,20 @@ lint = ["docutils-stubs", "flake8", "mypy"] standalone = ["Sphinx (>=5)"] test = ["html5lib", "pytest"] +[[package]] +name = "sphinxcontrib-jquery" +version = "4.1" +description = "Extension to include jQuery on newer Sphinx releases" +optional = false +python-versions = ">=2.7" +files = [ + {file = "sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"}, + {file = "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"}, +] + +[package.dependencies] +Sphinx = ">=1.8" + [[package]] name = "sphinxcontrib-jsmath" version = "1.0.1" @@ -4037,4 +4070,4 @@ test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "d4236ce8e886d8d87a001a180c8f49a8feb97f2fd1734a6ea02e89f835d4fec6" +content-hash = "2ca6d63bcf7d00724fa40284fed4395e0fc1988294858986a5d0cc380673bcfd" diff --git a/pyproject.toml b/pyproject.toml index 1845af0..bfb1565 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -72,6 +72,7 @@ pytest-cov = "^5.0.0" twine = "^5.1.1" sphinx = "^7.4.7" sphinxcontrib-napoleon = "^0.7" +sphinx-rtd-theme = "^2.0.0" [tool.mypy] ignore_missing_imports = true