Skip to content

Commit 760988c

Browse files
feat: add readthedocs config (#5)
Signed-off-by: Vincent Koppen <[email protected]>
1 parent 2fc8fee commit 760988c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

.readthedocs.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
2+
#
3+
# SPDX-License-Identifier: MPL-2.0
4+
5+
version: 2
6+
7+
# Build from the docs/ directory with Sphinx
8+
sphinx:
9+
configuration: docs/conf.py
10+
11+
build:
12+
os: "ubuntu-20.04"
13+
tools:
14+
python: "3.11"
15+
jobs:
16+
post_install:
17+
# Build package with doc requirements from pyproject.optional-dependencies
18+
- pip install --verbose --editable .[doc]
19+
# download support
20+
- wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/RELEASE.md
21+
- wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/SUPPORT.md
22+
- wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/SECURITY.md
23+
- wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/CITATION.md
24+
# download contribution
25+
- wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/GOVERNANCE.md
26+
- wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/CONTRIBUTING.md
27+
- wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/CODE_OF_CONDUCT.md
28+
# fix links
29+
- find docs/release_and_support -name "*.md" -exec sed -i -r "s|./CONTRIBUTING.md|../contribution/CONTRIBUTING.md|g" {} \;

0 commit comments

Comments
 (0)