From 1188b70bcee26082c921a3e305a8ae0b9e4c6ad7 Mon Sep 17 00:00:00 2001 From: Thibaud Coroller <14895385+tcoroller@users.noreply.github.com> Date: Mon, 15 Apr 2024 12:18:19 -0400 Subject: [PATCH 1/3] Update conf.py --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 3257ded..350f69c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,6 +26,7 @@ "sphinx.ext.coverage", "sphinx.ext.napoleon", "nbsphinx", + "sphinx.ext.viewcode", "sphinxcontrib.bibtex", ] From 64a0aba5086dd2bbc1b1796b71ec06a2ab76040c Mon Sep 17 00:00:00 2001 From: Peter Krusche Date: Mon, 15 Apr 2024 20:48:03 +0200 Subject: [PATCH 2/3] add docs test-build step to codeqc --- .github/workflows/codeqc.yml | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/workflows/codeqc.yml b/.github/workflows/codeqc.yml index 23f5dfc..8291a88 100644 --- a/.github/workflows/codeqc.yml +++ b/.github/workflows/codeqc.yml @@ -53,4 +53,18 @@ jobs: run: | conda activate torchsurv ./dev/run-doctests.sh - ./dev/run-unittests.sh \ No newline at end of file + ./dev/run-unittests.sh + + - name: Test-build docs + shell: bash -l {0} + run: | + conda activate torchsurv + ./dev/build-docs.sh + tar czvf docs.tar.gz -C docs/_build/html . + + - name: 'Upload Docs Tarball' + uses: actions/upload-artifact@v4 + with: + name: docs.tar.gz + path: docs.tar.gz + retention-days: 5 \ No newline at end of file From b75e813fa91b4e4cee0dd133d859316aea71d308 Mon Sep 17 00:00:00 2001 From: Peter Krusche Date: Mon, 15 Apr 2024 20:49:39 +0200 Subject: [PATCH 3/3] yaml fix --- .github/workflows/codeqc.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/codeqc.yml b/.github/workflows/codeqc.yml index 8291a88..e132eb8 100644 --- a/.github/workflows/codeqc.yml +++ b/.github/workflows/codeqc.yml @@ -63,8 +63,8 @@ jobs: tar czvf docs.tar.gz -C docs/_build/html . - name: 'Upload Docs Tarball' - uses: actions/upload-artifact@v4 - with: - name: docs.tar.gz - path: docs.tar.gz - retention-days: 5 \ No newline at end of file + uses: actions/upload-artifact@v4 + with: + name: docs.tar.gz + path: docs.tar.gz + retention-days: 5 \ No newline at end of file