diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..a5acee1ff --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,28 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html + python: + install: + - requirements: docs/requirements.txt diff --git a/doc/conf.py b/doc/conf.py index ebc929935..9931740e1 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -102,7 +102,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. @@ -207,10 +207,6 @@ # A list of files that should not be packed into the epub file. epub_exclude_files = ["search.html"] -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {"https://docs.python.org/": None} - - # -- Configuration for autodoc extensions --------------------------------- autodoc_default_options = { diff --git a/pyproject.toml b/pyproject.toml index 35a2e9fd8..a7d1eccba 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,7 +28,7 @@ dependencies = [ dynamic = ["version"] [project.optional-dependencies] -dev = ["pytest", "pytest-xdist"] +dev = ["pytest", "pytest-xdist", "sphinx", "sphinx_autodoc_typehints", "sphinx-rtd-theme"] [project.urls] Documentation = "https://iodata.readthedocs.io/en/latest/" diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 57ce308c4..000000000 --- a/readthedocs.yml +++ /dev/null @@ -1,5 +0,0 @@ -build: - image: latest - -conda: - file: environment.yml