From 63f6a4ab73130ba316b3ed3fd5472200def2b39a Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Fri, 20 Dec 2024 16:47:26 +0100 Subject: [PATCH 1/7] test the documentation generation workflow --- .github/workflows/idefix-ci-doc.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/idefix-ci-doc.yml diff --git a/.github/workflows/idefix-ci-doc.yml b/.github/workflows/idefix-ci-doc.yml new file mode 100644 index 00000000..66e75dda --- /dev/null +++ b/.github/workflows/idefix-ci-doc.yml @@ -0,0 +1,26 @@ +name: Idefix CIs +on: + workflow_dispatch: + push: + branches: + - master + - develop + - docCI + pull_request: + paths-ignore: + - '.github/ISSUE_TEMPLATE/*' + + +jobs: + ReadTheDocs: + runs-on: ubuntu-latest + steps: + - name: Check out repo + uses: actions/checkout@v3 + with: + submodules: recursive + - name: install dependencies + run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt + - name: compile documentation + run: python -m sphinx -T -b html -d _build/doctrees -D language=en . ./html + From af3d563803258b6e3a319252a54cf4e06928a3a0 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci-lite[bot]" <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com> Date: Fri, 20 Dec 2024 15:50:09 +0000 Subject: [PATCH 2/7] [pre-commit.ci lite] apply automatic fixes --- .github/workflows/idefix-ci-doc.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/idefix-ci-doc.yml b/.github/workflows/idefix-ci-doc.yml index 66e75dda..3f0a622c 100644 --- a/.github/workflows/idefix-ci-doc.yml +++ b/.github/workflows/idefix-ci-doc.yml @@ -23,4 +23,3 @@ jobs: run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt - name: compile documentation run: python -m sphinx -T -b html -d _build/doctrees -D language=en . ./html - From c060c419da184a31c0e3fc38bd28d09a4ae027f9 Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Fri, 20 Dec 2024 16:54:59 +0100 Subject: [PATCH 3/7] update path --- .github/workflows/idefix-ci-doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/idefix-ci-doc.yml b/.github/workflows/idefix-ci-doc.yml index 3f0a622c..77f48fd9 100644 --- a/.github/workflows/idefix-ci-doc.yml +++ b/.github/workflows/idefix-ci-doc.yml @@ -22,4 +22,4 @@ jobs: - name: install dependencies run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt - name: compile documentation - run: python -m sphinx -T -b html -d _build/doctrees -D language=en . ./html + run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/sources doc/html From c08fc76320f909f5a0e41ff30bd782ae9f1e22d3 Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Fri, 20 Dec 2024 16:58:14 +0100 Subject: [PATCH 4/7] typo --- .github/workflows/idefix-ci-doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/idefix-ci-doc.yml b/.github/workflows/idefix-ci-doc.yml index 77f48fd9..de8d8ffb 100644 --- a/.github/workflows/idefix-ci-doc.yml +++ b/.github/workflows/idefix-ci-doc.yml @@ -22,4 +22,4 @@ jobs: - name: install dependencies run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt - name: compile documentation - run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/sources doc/html + run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source doc/html From 3eaa696db6b2b4cb96dff1d477a142f983148040 Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Fri, 20 Dec 2024 16:59:58 +0100 Subject: [PATCH 5/7] add doxygen to the build --- .github/workflows/idefix-ci-doc.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/idefix-ci-doc.yml b/.github/workflows/idefix-ci-doc.yml index de8d8ffb..43e7aff8 100644 --- a/.github/workflows/idefix-ci-doc.yml +++ b/.github/workflows/idefix-ci-doc.yml @@ -20,6 +20,7 @@ jobs: with: submodules: recursive - name: install dependencies + run: sudo apt-get install -y doxygen run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt - name: compile documentation run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source doc/html From dee00e54bd96c2f322ed685841ce0b0d3ee39ce2 Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Fri, 20 Dec 2024 17:02:18 +0100 Subject: [PATCH 6/7] doxygen again --- .github/workflows/idefix-ci-doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/idefix-ci-doc.yml b/.github/workflows/idefix-ci-doc.yml index 43e7aff8..b6ae7133 100644 --- a/.github/workflows/idefix-ci-doc.yml +++ b/.github/workflows/idefix-ci-doc.yml @@ -5,7 +5,6 @@ on: branches: - master - develop - - docCI pull_request: paths-ignore: - '.github/ISSUE_TEMPLATE/*' @@ -21,6 +20,7 @@ jobs: submodules: recursive - name: install dependencies run: sudo apt-get install -y doxygen + - name: install doxygen run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt - name: compile documentation run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source doc/html From bfa54f724e3dc94cfba1a97c65f32539c7f6b354 Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Fri, 20 Dec 2024 17:09:37 +0100 Subject: [PATCH 7/7] clean naming no submodule (experimental) --- .github/workflows/idefix-ci-doc.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/idefix-ci-doc.yml b/.github/workflows/idefix-ci-doc.yml index b6ae7133..72b5dd0b 100644 --- a/.github/workflows/idefix-ci-doc.yml +++ b/.github/workflows/idefix-ci-doc.yml @@ -16,11 +16,9 @@ jobs: steps: - name: Check out repo uses: actions/checkout@v3 - with: - submodules: recursive - - name: install dependencies - run: sudo apt-get install -y doxygen - name: install doxygen + run: sudo apt-get install -y doxygen + - name: install python dependencies run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt - name: compile documentation run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source doc/html