diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..670ba48 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,21 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.in b/docs/requirements.in new file mode 100644 index 0000000..e69afdb --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,5 @@ +sphinx==7.3.7 +sphinx_rtd_theme==2.0.0 +readthedocs-sphinx-search==0.3.2 +numpy==1.26.4 +scipy==1.13.1 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..68524fe --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,65 @@ +# +# This file is autogenerated by pip-compile with Python 3.11 +# by the following command: +# +# pip-compile requirements.in +# +alabaster==0.7.16 + # via sphinx +babel==2.15.0 + # via sphinx +certifi==2024.2.2 + # via requests +charset-normalizer==3.3.2 + # via requests +docutils==0.20.1 + # via + # sphinx + # sphinx-rtd-theme +idna==3.7 + # via requests +imagesize==1.4.1 + # via sphinx +jinja2==3.1.4 + # via sphinx +markupsafe==2.1.5 + # via jinja2 +numpy==1.26.4 + # via + # -r requirements.in + # scipy +packaging==24.0 + # via sphinx +pygments==2.18.0 + # via sphinx +readthedocs-sphinx-search==0.3.2 + # via -r requirements.in +requests==2.32.2 + # via sphinx +scipy==1.13.1 + # via -r requirements.in +snowballstemmer==2.2.0 + # via sphinx +sphinx==7.3.7 + # via + # -r requirements.in + # sphinx-rtd-theme + # sphinxcontrib-jquery +sphinx-rtd-theme==2.0.0 + # via -r requirements.in +sphinxcontrib-applehelp==1.0.8 + # via sphinx +sphinxcontrib-devhelp==1.0.6 + # via sphinx +sphinxcontrib-htmlhelp==2.0.5 + # via sphinx +sphinxcontrib-jquery==4.1 + # via sphinx-rtd-theme +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==1.0.7 + # via sphinx +sphinxcontrib-serializinghtml==1.1.10 + # via sphinx +urllib3==2.2.1 + # via requests diff --git a/docs/source/conf.py b/docs/source/conf.py index 25ab67e..6a0c5a1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -70,7 +70,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -97,7 +97,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 = [] # Custom sidebar templates, must be a dictionary that maps document names # to template names.