fix pdf doc build, add broken link checking to linter

Author: bckohan

check.sh

@@ -18,4 +18,11 @@ poetry check
 poetry run pip check
 cd ./doc
 poetry run doc8 --ignore-path build --max-line-length 100 -q
+# check for broken links in the docs ############
+poetry run sphinx-build -b linkcheck -q -D linkcheck_timeout=5 ./source ./build > /dev/null 2>&1
+if [ $? -ne 0 ]; then
+    cat ./build/output.txt
+    exit 1
+fi
+#################################################
 cd ..

doc/source/conf.py

@@ -3,6 +3,7 @@
 import os
 from pathlib import Path
 from sphinx.ext.autodoc import between
+import shutil
 import django
 
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_typer.tests.settings.base')
@@ -97,4 +98,8 @@ def setup(app):
     # app.connect('html-page-context', add_page_class)
 
     app.add_directive("literalinclude", ExtendedLiteralInclude)
+    
+    # https://sphinxcontrib-typer.readthedocs.io/en/latest/howto.html#build-to-multiple-formats
+    if Path(app.doctreedir).exists():
+        shutil.rmtree(app.doctreedir)
     return app