From fbb482210d1ed37fb1b8e7aead2a10ad8bf70f80 Mon Sep 17 00:00:00 2001
From: Simon Heybrock <simon.heybrock@ess.eu>
Date: Thu, 19 May 2022 16:18:08 +0200
Subject: [PATCH] Cleanup and disable linkcheck

---
 .github/workflows/docs.yml |  4 ++--
 tox.ini                    | 18 ++++++------------
 2 files changed, 8 insertions(+), 14 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 07db3c23..379a5a68 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -32,9 +32,9 @@ jobs:
           python-version: 3.8
       - run: python -m pip install --upgrade pip
       - run: python -m pip install -r requirements/ci.txt
-      - run: tox --skip-pkg-install -e docs2 scippnexus
+      - run: tox --skip-pkg-install -e docs scippnexus
         if: ${{ github.event.inputs.publish == 'true' || inputs.publish }}
-      - run: tox -e docs2
+      - run: tox -e docs
         if: ${{ !(github.event.inputs.publish == 'true' || inputs.publish) }}
       - uses: actions/upload-artifact@v3
         with:
diff --git a/tox.ini b/tox.ini
index 0ca6a313..08f9f77a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -12,26 +12,20 @@ basepython = python3.8
 deps = -r requirements/test-lowest.txt
 commands = pytest
 
-[testenv:docs2]
+[testenv:docs]
 description = invoke sphinx-build to build the HTML docs
 basepython = python3.8
-deps =
-  {posargs:}
-  -r requirements/docs.txt
+deps = {posargs:}
+       -r requirements/docs.txt
 allowlist_externals=find
 commands = python -m sphinx -j2 -v -b html -d {toxworkdir}/docs_doctrees docs html
            python -m sphinx -j2 -v -b doctest -d {toxworkdir}/docs_doctrees docs html
            find html -type f -name "*.ipynb" -not -path "html/_sources/*" -delete
 
-[testenv:docs]
-description = invoke sphinx-build to build the HTML docs
-basepython = python3.8
+[testenv:linkcheck]
+description = Run Sphinx linkcheck
 deps = -r requirements/docs.txt
-allowlist_externals=find
-commands = python -m sphinx -j2 -v -b html -d {toxworkdir}/docs_doctrees docs html
-           python -m sphinx -j2 -v -b doctest -d {toxworkdir}/docs_doctrees docs html
-           python -m sphinx -j2 -v -b linkcheck -d {toxworkdir}/docs_doctrees docs html
-           find html -type f -name "*.ipynb" -not -path "html/_sources/*" -delete
+commands = python -m sphinx -j2 -v -b linkcheck -d {toxworkdir}/docs_doctrees docs html
 
 [testenv:static]
 description = Code formatting and static analysis