diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d5fda5f..f4e5e39 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,13 +1,7 @@ -# .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 + os: "ubuntu-22.04" tools: python: "3.10" jobs: @@ -15,18 +9,12 @@ build: # Install poetry # https://python-poetry.org/docs/#installing-manually - pip install poetry - # Tell poetry to not use a virtual environment - - poetry config virtualenvs.create false post_install: # Install dependencies with 'docs' dependency group # https://python-poetry.org/docs/managing-dependencies/#dependency-groups - - poetry install --with docs + # VIRTUAL_ENV needs to be set manually for now. + # See https://github.com/readthedocs/readthedocs.org/pull/11152/ + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs -# Build documentation in the docs/ directory with Sphinx sphinx: - configuration: docs/source/conf.py -# If using Sphinx, optionally build your docs in additional formats such as PDF -# formats: -# - pdf - -# Optionally declare the Python requirements required to build your docs + configuration: docs/source/conf.py \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 1f89253..4c3449d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -11,9 +11,9 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'auxiliary' -copyright = '2023, Florian Kofler et al.' -author = 'Florian Kofler et al.' +project = "auxiliary" +copyright = "2023, Florian Kofler et al." +author = "Florian Kofler et al." # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -26,7 +26,7 @@ "myst_parser", ] -templates_path = ['_templates'] +templates_path = ["_templates"] exclude_patterns = [] @@ -34,7 +34,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "sphinx_rtd_theme" -html_static_path = ['_static'] +html_static_path = ["_static"] autodoc_default_options = { "members": True,