diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..edf6289 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,29 @@ +# SPDX-FileCopyrightText: Contributors to the Power Grid Model project +# +# SPDX-License-Identifier: MPL-2.0 + +version: 2 + +# Build from the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +build: + os: "ubuntu-20.04" + tools: + python: "3.11" + jobs: + post_install: + # Build package with doc requirements from pyproject.optional-dependencies + - pip install --verbose --editable .[doc] + # download support + - wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/RELEASE.md + - wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/SUPPORT.md + - wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/SECURITY.md + - wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/CITATION.md + # download contribution + - wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/GOVERNANCE.md + - wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/CONTRIBUTING.md + - wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/CODE_OF_CONDUCT.md + # fix links + - find docs/release_and_support -name "*.md" -exec sed -i -r "s|./CONTRIBUTING.md|../contribution/CONTRIBUTING.md|g" {} \;