Skip to content

Commit

Permalink
feat: add readthedocs config (#5)
Browse files Browse the repository at this point in the history
Signed-off-by: Vincent Koppen <[email protected]>
  • Loading branch information
vincentkoppen authored Jan 17, 2025
1 parent 2fc8fee commit 760988c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
#
# 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" {} \;

0 comments on commit 760988c

Please sign in to comment.