diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..2bfc8ac --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,23 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + install: + - requirements: doc/requirements.txt + +build: + os: "ubuntu-22.04" + tools: + python: "3.11" diff --git a/doc/conf.py b/doc/conf.py index 2e02e3f..fe8eec3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -218,6 +218,6 @@ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - "https://docs.python.org/": None, - "https://numpy.org/doc/stable/": None, + "python": ("https://docs.python.org/3", None), + "numpy": ("https://numpy.org/doc/stable/", None), } diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..2cf6891 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +numpy +pandas +scikit-learn +scipy +sphinx +sphinx_rtd_theme