Linkchecker

.github/workflows/doc.yml

@@ -27,17 +27,24 @@ jobs:
           make html
           mv generated/html generated/html_
           mkdir generated/html
-          mv generated/html_ generated/html/autotag_metadata
-          touch generated/html/autotag_metadata/.nojekyll
-      # - name: check links
-      #   shell: bash -l {0}
-      #   run: |
-      #     # Strangely, the linkchecker modules are installed writable and linkchecker then refuses to load them.
-      #     chmod -R a-w `python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"`
+          mv generated/html_ generated/html/autotag-metadata
+          touch generated/html/autotag-metadata/.nojekyll
+      - name: fix permissions
+        shell: bash -l {0}
+        run: |
+          # Strangely, the linkchecker modules are installed writable and linkchecker then refuses to load them.
+          chmod -R a-w `python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"`
+      - name: detect broken links
+        shell: bash -l {0}
+        run: |
+          python -m http.server 8880 --directory doc/generated/html &
+          sleep 1
+          # sphinx creates a genindex page with an edit on github button, but that page does not exist in the repository.
+          linkchecker --check-extern http://localhost:8880/autotag-metadata --no-robots --ignore https://github.com/echemdb/autotag-metadata/blob/main/doc/genindex
       - uses: JamesIves/github-pages-deploy-action@v4.3.3
         with:
           branch: gh-pages
-          folder: doc/generated/html/autotag_metadata
+          folder: doc/generated/html/autotag-metadata
           target-folder: docs
           single-commit: true
         if: ${{ github.event_name == 'push' }}

doc/conf.py

@@ -1,5 +1,6 @@
-project = 'autotag-metadta'
+project = 'autotag-metadata'
 copyright = '2021-2023, the autotag-metadata authors'
+
 author = 'the autotag-metadata authors'
 
 release = '0.'

doc/installation.md

@@ -65,4 +65,4 @@ Starting autotag-metadata
 python -m autotag_metadata
 ```
 
-To verify changes made to the documentation refer to the [readme](https://github.com/echemdb/autotag-metadata/tree/main/doc/readme.md) in the repository.
+To verify changes made to the documentation refer to the [readme](https://github.com/echemdb/autotag-metadata/tree/main/doc/README.md) in the repository.

environment-dev.yml

@@ -32,3 +32,5 @@ dependencies:
   - types-toml>=0.10.0,<0.11.0
   - watchdog>=2.1,<2.2
   - yamllint>=1.26,<2
+  - pip:
+    - linkchecker