From f31d24eaf17562f8e388c3edfeeece814af015b4 Mon Sep 17 00:00:00 2001 From: ewuerger Date: Tue, 1 Oct 2024 14:47:55 +0200 Subject: [PATCH 1/4] docs: Fix `requirements.txt` --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 6242edf..6af82b0 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -13,3 +13,4 @@ sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.7 sphinxcontrib-serializinghtml==1.1.10 tomli==2.0.1 +capella2polarion==1.2.3 From dff8d4b9617c63f87801b42a04f491a1b9a8e0b3 Mon Sep 17 00:00:00 2001 From: ewuerger Date: Tue, 1 Oct 2024 14:59:25 +0200 Subject: [PATCH 2/4] docs: Reconfigure for rtd --- docs/.readthedocs.yaml | 8 +++++++- docs/requirements.txt | 16 ---------------- 2 files changed, 7 insertions(+), 17 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml index 364c163..fec461b 100644 --- a/docs/.readthedocs.yaml +++ b/docs/.readthedocs.yaml @@ -10,10 +10,16 @@ build: os: ubuntu-22.04 tools: python: "3.12" + jobs: + pre_build: + - sphinx-apidoc --output-dir docs/source/code --force . sphinx: configuration: docs/source/conf.py python: install: - - requirements: docs/requirements.txt + - method: pip + path: . + extra_requirements: + - docs diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 6af82b0..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,16 +0,0 @@ -# SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors -# SPDX-License-Identifier: CC0-1.0 - -furo==2024.1.29 -Sphinx==7.2.6 -sphinx-argparse-cli==1.13.1 -sphinx-basic-ng==1.0.0b2 -sphinx-copybutton==0.5.2 -sphinxcontrib-applehelp==1.0.8 -sphinxcontrib-devhelp==1.0.6 -sphinxcontrib-htmlhelp==2.0.5 -sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.7 -sphinxcontrib-serializinghtml==1.1.10 -tomli==2.0.1 -capella2polarion==1.2.3 From 72f4f32fb2e92e689aa59e7b512b7319d7227471 Mon Sep 17 00:00:00 2001 From: ewuerger Date: Tue, 1 Oct 2024 15:03:10 +0200 Subject: [PATCH 3/4] docs: Use makefile --- docs/.readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml index fec461b..509f613 100644 --- a/docs/.readthedocs.yaml +++ b/docs/.readthedocs.yaml @@ -12,7 +12,7 @@ build: python: "3.12" jobs: pre_build: - - sphinx-apidoc --output-dir docs/source/code --force . + - make -C docs html sphinx: configuration: docs/source/conf.py From 31fb84d97e83eb941f31f9d11e951945f1bdf762 Mon Sep 17 00:00:00 2001 From: ewuerger Date: Tue, 1 Oct 2024 15:03:46 +0200 Subject: [PATCH 4/4] ci(docs): remove duplicate step --- .github/workflows/docs.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 62b41a8..df55349 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,9 +25,6 @@ jobs: - name: Install dependencies run: | python -m pip install '.[docs]' - - name: Auto-generate APIDOC sources - run: |- - sphinx-apidoc --output-dir docs/source/code --force . - name: Create docs run: | make -C docs html