From 1c4bc1d9180f2dfcdca427a386f87fcb26b275f7 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Fri, 30 Jun 2023 00:14:10 +0200 Subject: [PATCH 1/5] Add nitpicky = True https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky --- docs/sphinx/source/conf.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index cd2d6b379d..dbb76909aa 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -466,3 +466,7 @@ def make_github_url(file_name): 'make_github_url': make_github_url, 'edit_page_url_template': '{{ make_github_url(file_name) }}', } + +# check internal references are valid +#https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky +nitpicky = True From a09fa8f71c459b827c48c9aede343c075f00b4ae Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 15 Jul 2023 18:37:47 +0200 Subject: [PATCH 2/5] Github action to schedule running the sphinx linkchecker --- .github/workflows/links_check.yml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/links_check.yml diff --git a/.github/workflows/links_check.yml b/.github/workflows/links_check.yml new file mode 100644 index 0000000000..e268b26216 --- /dev/null +++ b/.github/workflows/links_check.yml @@ -0,0 +1,29 @@ +name: Check Documentation Links + +on: + schedule: + # Biweekly at 00:00 on first and third Mondays + - cron: "0 0 1-7,15-21 * 1" + workflow_dispatch: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + doc: + name: Check Links + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - uses: actions/setup-python@v4 + with: + python-version: "3.8" + + - name: Install PVLIB and documentation dependencies + run: python pip install -e .[doc] + + - name: Run Sphinx linkcheck builder + run: | + cd docs/sphinx + make linkcheck SPHINXOPTS="-W --keep-going --color" From 24922ec1b3d1c536fb9a21c0939f640eff526854 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Thu, 27 Jul 2023 17:28:10 +0200 Subject: [PATCH 3/5] Apply working ubuntu workflow --- .github/workflows/links_check.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/links_check.yml b/.github/workflows/links_check.yml index e268b26216..391b260a64 100644 --- a/.github/workflows/links_check.yml +++ b/.github/workflows/links_check.yml @@ -20,10 +20,10 @@ jobs: with: python-version: "3.8" - - name: Install PVLIB and documentation dependencies - run: python pip install -e .[doc] + - name: Install PVLIB documentation dependencies + run: python -m pip install -e .[doc] - name: Run Sphinx linkcheck builder run: | cd docs/sphinx - make linkcheck SPHINXOPTS="-W --keep-going --color" + python -m sphinx -b linkcheck -T source build/linkcheck From 14c99da633ed4f3fcf8ac29fcce5547551d8bcce Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Thu, 27 Jul 2023 17:38:12 +0200 Subject: [PATCH 4/5] Delete nitpicky --- docs/sphinx/source/conf.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index dbb76909aa..cd2d6b379d 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -466,7 +466,3 @@ def make_github_url(file_name): 'make_github_url': make_github_url, 'edit_page_url_template': '{{ make_github_url(file_name) }}', } - -# check internal references are valid -#https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky -nitpicky = True From 1cec3d3132643931ad10c86b18e1ba60882b8ce2 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Thu, 27 Jul 2023 18:15:43 +0200 Subject: [PATCH 5/5] Ah, I forgot this --- .github/workflows/links_check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/links_check.yml b/.github/workflows/links_check.yml index 391b260a64..920829f500 100644 --- a/.github/workflows/links_check.yml +++ b/.github/workflows/links_check.yml @@ -26,4 +26,4 @@ jobs: - name: Run Sphinx linkcheck builder run: | cd docs/sphinx - python -m sphinx -b linkcheck -T source build/linkcheck + python -m sphinx -b linkcheck -T -W --keep-going source build/linkcheck