diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..d5c91da3 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,16 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build from the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + fail_on_warning: true + +# Explicitly set the version of Python and its requirements +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index ddb7c3d1..1da4eaa1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ extensions = ["sphinx.ext.autodoc"] # Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] +templates_path = [] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -53,7 +53,7 @@ # 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"] +html_static_path = [] # The master toctree document. master_doc = "index" diff --git a/docs/requirements.in b/docs/requirements.in new file mode 100644 index 00000000..e8c5a436 --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,2 @@ +sphinx<7.0.0 +sphinx_rtd_theme diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..ef557551 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,61 @@ +# +# This file is autogenerated by pip-compile with Python 3.9 +# by the following command: +# +# pip-compile --resolver=backtracking requirements.in +# +alabaster==0.7.13 + # via sphinx +babel==2.12.1 + # via sphinx +certifi==2023.5.7 + # via requests +charset-normalizer==3.1.0 + # via requests +docutils==0.18.1 + # via + # sphinx + # sphinx-rtd-theme +idna==3.4 + # via requests +imagesize==1.4.1 + # via sphinx +importlib-metadata==6.6.0 + # via sphinx +jinja2==3.1.2 + # via sphinx +markupsafe==2.1.2 + # via jinja2 +packaging==23.1 + # via sphinx +pygments==2.15.1 + # via sphinx +requests==2.30.0 + # via sphinx +snowballstemmer==2.2.0 + # via sphinx +sphinx==6.2.1 + # via + # -r requirements.in + # sphinx-rtd-theme + # sphinxcontrib-jquery +sphinx-rtd-theme==1.2.0 + # via -r requirements.in +sphinxcontrib-applehelp==1.0.4 + # via sphinx +sphinxcontrib-devhelp==1.0.2 + # via sphinx +sphinxcontrib-htmlhelp==2.0.1 + # via sphinx +sphinxcontrib-jquery==4.1 + # via sphinx-rtd-theme +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==1.0.3 + # via sphinx +sphinxcontrib-serializinghtml==1.1.5 + # via sphinx +urllib3==2.0.2 + # via requests +zipp==3.15.0 + # via importlib-metadata diff --git a/pyproject.toml b/pyproject.toml index 3e45bf4f..e4bf9116 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -50,6 +50,9 @@ dynamic = [ ] [project.optional-dependencies] +docs = [ + "pip-tools>=6.13.0", +] test = [ "assertpy>=1.1", "beautifulsoup4>=4.11.1",