From ff8f1489027bf91bf9a60946bb7a22c863b8e1c5 Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Tue, 17 Dec 2024 22:04:14 +0530 Subject: [PATCH 01/12] Added a link checker step in the doctests jobs using both Lychee and Sphinx parallelly --- .../{lychee_url_checker.yml => links.yml} | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) rename .github/workflows/{lychee_url_checker.yml => links.yml} (77%) diff --git a/.github/workflows/lychee_url_checker.yml b/.github/workflows/links.yml similarity index 77% rename from .github/workflows/lychee_url_checker.yml rename to .github/workflows/links.yml index 98dd7a266d..ddcd10a0fa 100644 --- a/.github/workflows/lychee_url_checker.yml +++ b/.github/workflows/links.yml @@ -1,4 +1,4 @@ -name: Check URLs with Lychee +name: Check URLs with Lychee and Sphinx on: push: @@ -11,7 +11,7 @@ on: - cron: "0 3 * * *" jobs: - linkChecker: + linkCheckerLychee: runs-on: ubuntu-latest steps: @@ -61,3 +61,17 @@ jobs: env: # to be used in case rate limits are surpassed GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + linkcheckerSphinx: + runs-on: ubuntu-latest + needs: linkCheckerLychee + + steps: + # Checkout repository code + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + + # Run Sphinx's linkcheck builder + - name: Run Sphinx linkcheck + run: | + sphinx-build -b linkcheck . _build/linkcheck || exit 1 #Fail the job if the link is broken + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file From e126bf5eba03fcd2656f0160d2d1ded10eb0bde7 Mon Sep 17 00:00:00 2001 From: RohitP2005 <122815777+RohitP2005@users.noreply.github.com> Date: Wed, 18 Dec 2024 00:08:53 +0530 Subject: [PATCH 02/12] Update .github/workflows/links.yml Co-authored-by: Eric G. Kratz --- .github/workflows/links.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index ddcd10a0fa..3b86b51e0e 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -74,4 +74,4 @@ jobs: run: | sphinx-build -b linkcheck . _build/linkcheck || exit 1 #Fail the job if the link is broken env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 38d3e96e1faa7a28fc346f4de4884a8c30e6481d Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Wed, 18 Dec 2024 09:07:43 +0530 Subject: [PATCH 03/12] Changes in kinks.yml[Build Pybam] --- .github/workflows/links.yml | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 3b86b51e0e..5bdc6252e2 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -15,22 +15,20 @@ jobs: runs-on: ubuntu-latest steps: - # cache Lychee results to avoid hitting rate limits + # Cache Lychee results to avoid hitting rate limits - name: Restore lychee cache - uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0 + uses: actions/cache@v4 with: path: .lycheecache key: cache-lychee-${{ github.sha }} restore-keys: cache-lychee- - # check URLs with Lychee - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + # Check URLs with Lychee + - uses: actions/checkout@v4 - # use stable version for now to avoid breaking changes - name: Lychee URL checker - uses: lycheeverse/lychee-action@f81112d0d2814ded911bd23e3beaa9dda9093915 # v2.1.0 + uses: lycheeverse/lychee-action@v2.1.0 with: - # arguments with file types to check args: >- --cache --no-progress @@ -54,24 +52,34 @@ jobs: './**/*.ipynb' './**/*.json' './**/*.toml' - # fail the action on broken links fail: true jobSummary: true format: markdown env: - # to be used in case rate limits are surpassed - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + linkcheckerSphinx: runs-on: ubuntu-latest needs: linkCheckerLychee - + steps: # Checkout repository code - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + - uses: actions/checkout@v4 + + # Install Python and dependencies for Sphinx + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.9" + + - name: Install PyBaMM with [docs,all] + run: | + python -m pip install --upgrade pip + pip install -e .[docs,all] # Run Sphinx's linkcheck builder - name: Run Sphinx linkcheck run: | - sphinx-build -b linkcheck . _build/linkcheck || exit 1 #Fail the job if the link is broken + sphinx-build -b linkcheck . _build/linkcheck || exit 1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 404b92883f57af1af575a23035f01a387ba89733 Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Wed, 18 Dec 2024 19:18:16 +0530 Subject: [PATCH 04/12] feat: add docs.yml workflow to handle all CI tasks related to documentation --- .github/workflows/{links.yml => docs.yml} | 94 ++++++++++++++--------- .github/workflows/test_on_push.yml | 88 ++++++++++----------- 2 files changed, 100 insertions(+), 82 deletions(-) rename .github/workflows/{links.yml => docs.yml} (52%) diff --git a/.github/workflows/links.yml b/.github/workflows/docs.yml similarity index 52% rename from .github/workflows/links.yml rename to .github/workflows/docs.yml index 5bdc6252e2..60ac7c2dbd 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/docs.yml @@ -1,31 +1,75 @@ -name: Check URLs with Lychee and Sphinx +name: Documentation on: + workflow_dispatch: + pull_requests: push: branches: - main - develop - pull_request: schedule: - # Run everyday at 3 am UTC + # Run every day at 3 am UTC - cron: "0 3 * * *" +env: + PYBAMM_DISABLE_TELEMETRY: "true" + FORCE_COLOR: 3 + PYBAMM_IDAKLU_EXPR_CASADI: ON + PYBAMM_IDAKLU_EXPR_IREE: ON + +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + jobs: - linkCheckerLychee: + docs: runs-on: ubuntu-latest steps: + # Checkout repository code + - name: Check out repository + uses: actions/checkout@v4 + + # Install Linux system dependencies + - name: Install Linux system dependencies + uses: awalsh128/cache-apt-pkgs-action@a6c3917cc929dd0345bfb2d3feaf9101823370ad # v1.4.2 + with: + packages: graphviz pandoc + execute_install_scripts: true - # Cache Lychee results to avoid hitting rate limits - - name: Restore lychee cache - uses: actions/cache@v4 + # Install TeXLive for Linux + - name: Install TeXLive for Linux + run: | + sudo apt-get update + sudo apt-get install texlive-latex-extra dvipng + + # Set up Python + - name: Set up Python + uses: actions/setup-python@v4 with: - path: .lycheecache - key: cache-lychee-${{ github.sha }} - restore-keys: cache-lychee- + python-version: "3.11" + cache: 'pip' - # Check URLs with Lychee - - uses: actions/checkout@v4 + # Upgrade pip and install dependencies for PyBaMM + - name: Install PyBaMM with [docs,all] + run: | + python -m pip install --upgrade pip + pip install -e .[docs,all] + + # Run doctests for Python 3.11 + - name: Run doctests + run: python -m nox -s doctests + + # Build the docs (HTML) + - name: Build docs (HTML) + run: sphinx-build -b html docs/ docs/_build/html + + # Check links in the documentation with Sphinx + - name: Run Sphinx linkcheck + run: sphinx-build -b linkcheck docs/ docs/_build/linkcheck + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # Run Lychee URL checker in parallel (No redundant checkout) - name: Lychee URL checker uses: lycheeverse/lychee-action@v2.1.0 with: @@ -57,29 +101,3 @@ jobs: format: markdown env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - linkcheckerSphinx: - runs-on: ubuntu-latest - needs: linkCheckerLychee - - steps: - # Checkout repository code - - uses: actions/checkout@v4 - - # Install Python and dependencies for Sphinx - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: "3.9" - - - name: Install PyBaMM with [docs,all] - run: | - python -m pip install --upgrade pip - pip install -e .[docs,all] - - # Run Sphinx's linkcheck builder - - name: Run Sphinx linkcheck - run: | - sphinx-build -b linkcheck . _build/linkcheck || exit 1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/test_on_push.yml b/.github/workflows/test_on_push.yml index 3443279414..c67079e368 100644 --- a/.github/workflows/test_on_push.yml +++ b/.github/workflows/test_on_push.yml @@ -131,50 +131,50 @@ jobs: run: python -m nox -s integration # Skips IDAKLU module compilation for speedups, which is already tested in other jobs. - run_doctests: - runs-on: ubuntu-latest - strategy: - fail-fast: false - name: Doctests (ubuntu-latest / Python 3.11) - - steps: - - name: Check out PyBaMM repository - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - with: - fetch-depth: 0 - - - name: Install Linux system dependencies - uses: awalsh128/cache-apt-pkgs-action@a6c3917cc929dd0345bfb2d3feaf9101823370ad # v1.4.2 - with: - packages: graphviz pandoc - execute_install_scripts: true - - # dot -c is for registering graphviz fonts and plugins - - name: Install TeXLive for Linux - run: | - sudo apt-get update - sudo dot -c - sudo apt-get install texlive-latex-extra dvipng - - - name: Set up Python - id: setup-python - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 - with: - python-version: 3.11 - cache: 'pip' - - - name: Set up uv - run: python -m pip install uv - - - name: Install nox - run: python -m uv pip install nox[uv] - - - name: Install docs dependencies and run doctests for GNU/Linux - run: python -m nox -s doctests - - - name: Check if the documentation can be built for GNU/Linux - run: python -m nox -s docs - + # run_doctests: + # runs-on: ubuntu-latest + # strategy: + # fail-fast: false + # name: Doctests (ubuntu-latest / Python 3.11) + # + # steps: + # - name: Check out PyBaMM repository + # uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + # with: + # fetch-depth: 0 + # + # - name: Install Linux system dependencies + # uses: awalsh128/cache-apt-pkgs-action@a6c3917cc929dd0345bfb2d3feaf9101823370ad # v1.4.2 + # with: + # packages: graphviz pandoc + # execute_install_scripts: true + # + # # dot -c is for registering graphviz fonts and plugins + # - name: Install TeXLive for Linux + # run: | + # sudo apt-get update + # sudo dot -c + # sudo apt-get install texlive-latex-extra dvipng + # + # - name: Set up Python + # id: setup-python + # uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 + # with: + # python-version: 3.11 + # cache: 'pip' + # + # - name: Set up uv + # run: python -m pip install uv + # + # - name: Install nox + # run: python -m uv pip install nox[uv] + # + # - name: Install docs dependencies and run doctests for GNU/Linux + # run: python -m nox -s doctests + # + # - name: Check if the documentation can be built for GNU/Linux + # run: python -m nox -s docs + # run_example_tests: runs-on: ubuntu-latest strategy: From 3b642d7f4c7a48e6041f9d7baabbf0945a8684c0 Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Wed, 18 Dec 2024 22:50:58 +0530 Subject: [PATCH 05/12] Rearranging of functionalities and corrections were made --- .github/workflows/lychee_url_checker.yml | 63 +++++++++++++++++++ .../{docs.yml => test_docs_build.yml} | 28 +++------ .github/workflows/test_on_push.yml | 45 +------------ 3 files changed, 71 insertions(+), 65 deletions(-) create mode 100644 .github/workflows/lychee_url_checker.yml rename .github/workflows/{docs.yml => test_docs_build.yml} (74%) diff --git a/.github/workflows/lychee_url_checker.yml b/.github/workflows/lychee_url_checker.yml new file mode 100644 index 0000000000..98dd7a266d --- /dev/null +++ b/.github/workflows/lychee_url_checker.yml @@ -0,0 +1,63 @@ +name: Check URLs with Lychee + +on: + push: + branches: + - main + - develop + pull_request: + schedule: + # Run everyday at 3 am UTC + - cron: "0 3 * * *" + +jobs: + linkChecker: + runs-on: ubuntu-latest + steps: + + # cache Lychee results to avoid hitting rate limits + - name: Restore lychee cache + uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0 + with: + path: .lycheecache + key: cache-lychee-${{ github.sha }} + restore-keys: cache-lychee- + + # check URLs with Lychee + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + + # use stable version for now to avoid breaking changes + - name: Lychee URL checker + uses: lycheeverse/lychee-action@f81112d0d2814ded911bd23e3beaa9dda9093915 # v2.1.0 + with: + # arguments with file types to check + args: >- + --cache + --no-progress + --max-cache-age 2d + --timeout 10 + --max-retries 5 + --skip-missing + --exclude-loopback + --exclude https://twitter.com/pybamm_ + --exclude "https://doi\.org|www.sciencedirect\.com/*" + --exclude https://www.rse.ox.ac.uk + --accept 200,429 + --exclude-path ./CHANGELOG.md + --exclude-path ./scripts/update_version.py + --exclude-path asv.conf.json + --exclude-path docs/conf.py + --exclude-path all_contributors.md + './**/*.rst' + './**/*.md' + './**/*.py' + './**/*.ipynb' + './**/*.json' + './**/*.toml' + # fail the action on broken links + fail: true + jobSummary: true + format: markdown + env: + # to be used in case rate limits are surpassed + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.github/workflows/docs.yml b/.github/workflows/test_docs_build.yml similarity index 74% rename from .github/workflows/docs.yml rename to .github/workflows/test_docs_build.yml index 60ac7c2dbd..7b682a9335 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/test_docs_build.yml @@ -2,7 +2,7 @@ name: Documentation on: workflow_dispatch: - pull_requests: + pull_request: push: branches: - main @@ -14,8 +14,8 @@ on: env: PYBAMM_DISABLE_TELEMETRY: "true" FORCE_COLOR: 3 - PYBAMM_IDAKLU_EXPR_CASADI: ON - PYBAMM_IDAKLU_EXPR_IREE: ON + PYBAMM_IDAKLU_EXPR_CASADI: OFF + PYBAMM_IDAKLU_EXPR_IREE: OFF concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} @@ -25,47 +25,35 @@ jobs: docs: runs-on: ubuntu-latest steps: - # Checkout repository code + - name: Check out repository uses: actions/checkout@v4 - # Install Linux system dependencies - name: Install Linux system dependencies uses: awalsh128/cache-apt-pkgs-action@a6c3917cc929dd0345bfb2d3feaf9101823370ad # v1.4.2 with: packages: graphviz pandoc execute_install_scripts: true - # Install TeXLive for Linux - - name: Install TeXLive for Linux - run: | - sudo apt-get update - sudo apt-get install texlive-latex-extra dvipng - - # Set up Python - name: Set up Python uses: actions/setup-python@v4 with: python-version: "3.11" cache: 'pip' - # Upgrade pip and install dependencies for PyBaMM - - name: Install PyBaMM with [docs,all] + - name: Install PyBaMM with [docs,dev,all] run: | python -m pip install --upgrade pip - pip install -e .[docs,all] + pip install -e .[docs,dev,all] - # Run doctests for Python 3.11 - name: Run doctests run: python -m nox -s doctests - # Build the docs (HTML) - name: Build docs (HTML) run: sphinx-build -b html docs/ docs/_build/html - # Check links in the documentation with Sphinx - name: Run Sphinx linkcheck - run: sphinx-build -b linkcheck docs/ docs/_build/linkcheck + run: sphinx-build -b linkcheck -d docs/_build/.doctrees docs docs/_build env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -99,5 +87,3 @@ jobs: fail: true jobSummary: true format: markdown - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/test_on_push.yml b/.github/workflows/test_on_push.yml index c67079e368..372bd70b70 100644 --- a/.github/workflows/test_on_push.yml +++ b/.github/workflows/test_on_push.yml @@ -131,50 +131,7 @@ jobs: run: python -m nox -s integration # Skips IDAKLU module compilation for speedups, which is already tested in other jobs. - # run_doctests: - # runs-on: ubuntu-latest - # strategy: - # fail-fast: false - # name: Doctests (ubuntu-latest / Python 3.11) - # - # steps: - # - name: Check out PyBaMM repository - # uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - # with: - # fetch-depth: 0 - # - # - name: Install Linux system dependencies - # uses: awalsh128/cache-apt-pkgs-action@a6c3917cc929dd0345bfb2d3feaf9101823370ad # v1.4.2 - # with: - # packages: graphviz pandoc - # execute_install_scripts: true - # - # # dot -c is for registering graphviz fonts and plugins - # - name: Install TeXLive for Linux - # run: | - # sudo apt-get update - # sudo dot -c - # sudo apt-get install texlive-latex-extra dvipng - # - # - name: Set up Python - # id: setup-python - # uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 - # with: - # python-version: 3.11 - # cache: 'pip' - # - # - name: Set up uv - # run: python -m pip install uv - # - # - name: Install nox - # run: python -m uv pip install nox[uv] - # - # - name: Install docs dependencies and run doctests for GNU/Linux - # run: python -m nox -s doctests - # - # - name: Check if the documentation can be built for GNU/Linux - # run: python -m nox -s docs - # + run_example_tests: runs-on: ubuntu-latest strategy: From 63cc8f7b2a46c0b4074b78510a936e5ff7686828 Mon Sep 17 00:00:00 2001 From: RohitP2005 <122815777+RohitP2005@users.noreply.github.com> Date: Wed, 18 Dec 2024 22:55:28 +0530 Subject: [PATCH 06/12] Update test_docs_build.yml --- .github/workflows/test_docs_build.yml | 34 +-------------------------- 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/.github/workflows/test_docs_build.yml b/.github/workflows/test_docs_build.yml index 7b682a9335..6c544763ff 100644 --- a/.github/workflows/test_docs_build.yml +++ b/.github/workflows/test_docs_build.yml @@ -54,36 +54,4 @@ jobs: - name: Run Sphinx linkcheck run: sphinx-build -b linkcheck -d docs/_build/.doctrees docs docs/_build - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - # Run Lychee URL checker in parallel (No redundant checkout) - - name: Lychee URL checker - uses: lycheeverse/lychee-action@v2.1.0 - with: - args: >- - --cache - --no-progress - --max-cache-age 2d - --timeout 10 - --max-retries 5 - --skip-missing - --exclude-loopback - --exclude https://twitter.com/pybamm_ - --exclude "https://doi\.org|www.sciencedirect\.com/*" - --exclude https://www.rse.ox.ac.uk - --accept 200,429 - --exclude-path ./CHANGELOG.md - --exclude-path ./scripts/update_version.py - --exclude-path asv.conf.json - --exclude-path docs/conf.py - --exclude-path all_contributors.md - './**/*.rst' - './**/*.md' - './**/*.py' - './**/*.ipynb' - './**/*.json' - './**/*.toml' - fail: true - jobSummary: true - format: markdown + From 034c389747eaf07baa5cb08281e8e196a315f685 Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Wed, 18 Dec 2024 23:00:21 +0530 Subject: [PATCH 07/12] performed pre-commit --- .github/workflows/test_docs_build.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/test_docs_build.yml b/.github/workflows/test_docs_build.yml index 6c544763ff..0bff7d96b3 100644 --- a/.github/workflows/test_docs_build.yml +++ b/.github/workflows/test_docs_build.yml @@ -54,4 +54,3 @@ jobs: - name: Run Sphinx linkcheck run: sphinx-build -b linkcheck -d docs/_build/.doctrees docs docs/_build - From 299697e4996dee2b9826d46a92098d29cdceba39 Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Wed, 18 Dec 2024 23:29:46 +0530 Subject: [PATCH 08/12] removed push and schedule from test_docs_buil.yml --- .github/workflows/test_docs_build.yml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.github/workflows/test_docs_build.yml b/.github/workflows/test_docs_build.yml index 0bff7d96b3..53c19b107b 100644 --- a/.github/workflows/test_docs_build.yml +++ b/.github/workflows/test_docs_build.yml @@ -3,13 +3,6 @@ name: Documentation on: workflow_dispatch: pull_request: - push: - branches: - - main - - develop - schedule: - # Run every day at 3 am UTC - - cron: "0 3 * * *" env: PYBAMM_DISABLE_TELEMETRY: "true" From 833358bfddad693f755b16d7649890ca8bb8df9b Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Thu, 19 Dec 2024 00:29:18 +0530 Subject: [PATCH 09/12] Modified build docs html in test_docs_build.yml --- .github/workflows/test_docs_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test_docs_build.yml b/.github/workflows/test_docs_build.yml index 53c19b107b..b6e5fbe20f 100644 --- a/.github/workflows/test_docs_build.yml +++ b/.github/workflows/test_docs_build.yml @@ -43,7 +43,7 @@ jobs: run: python -m nox -s doctests - name: Build docs (HTML) - run: sphinx-build -b html docs/ docs/_build/html + run: sphinx-build -b html -d docs/_build/.doctrees docs docs/_build - name: Run Sphinx linkcheck run: sphinx-build -b linkcheck -d docs/_build/.doctrees docs docs/_build From ee5dc5c107866337a0d90ceef4c526aba9affcce Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Thu, 19 Dec 2024 09:47:22 +0530 Subject: [PATCH 10/12] added flags to ignore warning --- .github/workflows/test_docs_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test_docs_build.yml b/.github/workflows/test_docs_build.yml index b6e5fbe20f..5824b98e7a 100644 --- a/.github/workflows/test_docs_build.yml +++ b/.github/workflows/test_docs_build.yml @@ -43,7 +43,7 @@ jobs: run: python -m nox -s doctests - name: Build docs (HTML) - run: sphinx-build -b html -d docs/_build/.doctrees docs docs/_build + run: sphinx-build -b html -W --keep-going -d docs/_build/.doctrees docs docs/_build - name: Run Sphinx linkcheck run: sphinx-build -b linkcheck -d docs/_build/.doctrees docs docs/_build From 981a833b28331d5e6b127a186b80cf80e5366171 Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Thu, 19 Dec 2024 09:49:11 +0530 Subject: [PATCH 11/12] Modified the doctest command --- .github/workflows/test_docs_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test_docs_build.yml b/.github/workflows/test_docs_build.yml index 5824b98e7a..65a4a8ab49 100644 --- a/.github/workflows/test_docs_build.yml +++ b/.github/workflows/test_docs_build.yml @@ -40,7 +40,7 @@ jobs: pip install -e .[docs,dev,all] - name: Run doctests - run: python -m nox -s doctests + run: python -m pytest --doctest-plus src - name: Build docs (HTML) run: sphinx-build -b html -W --keep-going -d docs/_build/.doctrees docs docs/_build From efbf6d66a3d31b767491da97c7eee2a827b74b3d Mon Sep 17 00:00:00 2001 From: RohitP2005 Date: Thu, 19 Dec 2024 09:50:23 +0530 Subject: [PATCH 12/12] Removed a comment from test_on_push.yml --- .github/workflows/test_on_push.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test_on_push.yml b/.github/workflows/test_on_push.yml index 372bd70b70..ccbc5a13e3 100644 --- a/.github/workflows/test_on_push.yml +++ b/.github/workflows/test_on_push.yml @@ -130,7 +130,7 @@ jobs: - name: Run integration tests for ${{ matrix.os }} with Python ${{ matrix.python-version }} run: python -m nox -s integration - # Skips IDAKLU module compilation for speedups, which is already tested in other jobs. + run_example_tests: runs-on: ubuntu-latest