Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,6 @@ jobs:
uses: actions/checkout@v6
with:
submodules: true

- name: Install documentation dependencies
run: |
sudo apt-get update
Expand Down Expand Up @@ -181,3 +180,5 @@ jobs:

- name: Build Sphinx documentation
run: make docs SPHINX_FLAGS=-W
- name: Check documentation links
run: make linkcheck-docs
5 changes: 4 additions & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -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=
Expand Down
1 change: 1 addition & 0 deletions changes/194.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed broken link in ``api/asdf/file.h``.
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 --------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion include/asdf/file.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ASDF Numeric Literals>`_ writing them to ASDF files. Nevertheless
* :ref:`forbids <asdf-standard:numeric-literals>` 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``.
Expand Down
Loading