From 27d3460146a255f581a337af2acf11ce2d741ba1 Mon Sep 17 00:00:00 2001 From: Sydney Duckworth Date: Thu, 5 Nov 2026 10:09:22 -0500 Subject: [PATCH 1/8] Added `linkcheck-docs` target to makefile for running Sphinx `linkcheck` --- Makefile.am | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Makefile.am b/Makefile.am index 95ede50f..c3cfce6f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -149,8 +149,11 @@ docs: distcheck-docs: $(MAKE) docs SPHINX_FLAGS=-W + +linkcheck-docs: + $(SPHINXBUILD) $(SPHINX_FLAGS) -b linkcheck $(srcdir)/docs $(builddir)/docs/_build/linkcheck endif -.PHONY: docs distcheck-docs +.PHONY: docs distcheck-docs linkcheck-docs CMAKE_EXTRA_FLAGS= From c77083be9b1bef9f2177cc0203e295961731def7 Mon Sep 17 00:00:00 2001 From: Sydney Duckworth Date: Thu, 5 Nov 2026 10:09:59 -0500 Subject: [PATCH 2/8] Added `linkcheck` step to CI --- .github/workflows/build.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5064e6c7..6eca1e82 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -181,3 +181,5 @@ jobs: - name: Build Sphinx documentation run: make docs SPHINX_FLAGS=-W + - name: Check documentation links + run: make linkcheck-docs From 41e65183633b6137b544fa826c0a05e681974db7 Mon Sep 17 00:00:00 2001 From: Sydney Duckworth Date: Thu, 5 Nov 2026 10:10:12 -0500 Subject: [PATCH 3/8] Fixed broken link --- include/asdf/file.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/asdf/file.h b/include/asdf/file.h index fee07c94..6b6c9693 100644 --- a/include/asdf/file.h +++ b/include/asdf/file.h @@ -710,7 +710,7 @@ ASDF_EXPORT bool asdf_is_null(asdf_file_t *file, const char *path); * * Big integers (greater than ``UINT64_MAX`` or less than ``INT64_MIN``) are * not supported--in fact the ASDF Standard expressly - * `forbids `_ writing them to ASDF files. Nevertheless + * :ref:`forbids ` writing them to ASDF files. Nevertheless * it could be supported in the future if the need arises. In fact, * technically the ASDF Standard disallows integers greater than ``INT64_MAX`` * but here we do allow unsigned integers up to ``UINT64_MAX``. From 395e1b52de1b25f6ad0e4e6875890a5f7ab00d39 Mon Sep 17 00:00:00 2001 From: Sydney Duckworth Date: Thu, 5 Nov 2026 10:33:07 -0500 Subject: [PATCH 4/8] Added changelog entry --- changes/194.doc.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 changes/194.doc.rst diff --git a/changes/194.doc.rst b/changes/194.doc.rst new file mode 100644 index 00000000..d605ef27 --- /dev/null +++ b/changes/194.doc.rst @@ -0,0 +1 @@ +Fixed broken link in ``api/asdf/file.h``. From 8225a87785f43ef214194f9ee519b9ebba5b7fbf Mon Sep 17 00:00:00 2001 From: Sydney Duckworth Date: Thu, 5 Nov 2026 12:29:09 -0500 Subject: [PATCH 5/8] Updated CI doc Python version --- .github/workflows/build.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6eca1e82..37facc47 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -144,7 +144,10 @@ jobs: uses: actions/checkout@v6 with: submodules: true - + - name: Setup Python + uses: actions/setup-python@v7 + with: + python-version: '3.14' - name: Install documentation dependencies run: | sudo apt-get update @@ -161,7 +164,7 @@ jobs: libstatgrab-dev \ llvm \ python3-clang - pip install furo hawkmoth towncrier 'sphinx>=9.0' + python -m pip install furo hawkmoth towncrier 'sphinx>=9.0' - name: Set LD_LIBRARY_PATH run: echo "LD_LIBRARY_PATH=$(llvm-config --libdir):$LD_LIBRARY_PATH" >> $GITHUB_ENV From 6fe0987497733cfe9b6695dbf6198158ab4cb536 Mon Sep 17 00:00:00 2001 From: Sydney Duckworth Date: Thu, 5 Nov 2026 13:50:03 -0500 Subject: [PATCH 6/8] Set encoding header for `linkcheck` --- .github/workflows/build.yml | 6 +----- docs/conf.py | 3 +++ 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 37facc47..71f2422d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -144,10 +144,6 @@ jobs: uses: actions/checkout@v6 with: submodules: true - - name: Setup Python - uses: actions/setup-python@v7 - with: - python-version: '3.14' - name: Install documentation dependencies run: | sudo apt-get update @@ -164,7 +160,7 @@ jobs: libstatgrab-dev \ llvm \ python3-clang - python -m pip install furo hawkmoth towncrier 'sphinx>=9.0' + pip install furo hawkmoth towncrier 'sphinx>=9.0' - name: Set LD_LIBRARY_PATH run: echo "LD_LIBRARY_PATH=$(llvm-config --libdir):$LD_LIBRARY_PATH" >> $GITHUB_ENV diff --git a/docs/conf.py b/docs/conf.py index 741bd610..e0e19f08 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -150,6 +150,9 @@ def read_config_h() -> tuple[str, str, str]: # Local; see docs/_ext/ 'index_grouping', ] +linkcheck_request_headers = { + "Accept-Encoding": "gzip" +} # -- Options for hawkmoth extension -------------------------------------------- From 890a482ee5494286d83ed5cdc2e742e1121a92d8 Mon Sep 17 00:00:00 2001 From: Sydney Duckworth Date: Thu, 5 Nov 2026 14:26:43 -0500 Subject: [PATCH 7/8] fixup! Set encoding header for `linkcheck` --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index e0e19f08..e13f1efa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -151,7 +151,9 @@ def read_config_h() -> tuple[str, str, str]: 'index_grouping', ] linkcheck_request_headers = { - "Accept-Encoding": "gzip" + "*": { + "Accept-Encoding": "gzip" + } } # -- Options for hawkmoth extension -------------------------------------------- From 18182b630bf30b6501b1ccb82d315706d32bece2 Mon Sep 17 00:00:00 2001 From: Sydney Duckworth Date: Thu, 5 Nov 2026 14:46:21 -0500 Subject: [PATCH 8/8] fixup! Set encoding header for `linkcheck` --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index e13f1efa..9506a68a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -152,6 +152,7 @@ def read_config_h() -> tuple[str, str, str]: ] linkcheck_request_headers = { "*": { + # Needed because Cloudflare domains default to zstd which breaks on Github CI "Accept-Encoding": "gzip" } }