diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5064e6c7..71f2422d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -144,7 +144,6 @@ jobs: uses: actions/checkout@v6 with: submodules: true - - name: Install documentation dependencies run: | sudo apt-get update @@ -181,3 +180,5 @@ jobs: - name: Build Sphinx documentation run: make docs SPHINX_FLAGS=-W + - name: Check documentation links + run: make linkcheck-docs 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= 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``. diff --git a/docs/conf.py b/docs/conf.py index 741bd610..9506a68a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -150,6 +150,12 @@ def read_config_h() -> tuple[str, str, str]: # Local; see docs/_ext/ 'index_grouping', ] +linkcheck_request_headers = { + "*": { + # Needed because Cloudflare domains default to zstd which breaks on Github CI + "Accept-Encoding": "gzip" + } +} # -- Options for hawkmoth extension -------------------------------------------- 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``.