Skip to content

Commit

Permalink
Workaround satre.xlsx linkcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
manics committed Oct 10, 2023
1 parent f5f5261 commit 14ed04c
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,20 @@
"satrecsv",
]

# The :download: roles inserts a hash into the URL which varies between builds
# This allows us to use a consistent URL
# The :download: role inserts a hash into the URL which varies between builds
# Along with
# https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#customising-external-url-resolution
# this allows us to use a consistent URL
html_extra_path = ["../build/satrecsv/satre.xlsx"]

linkcheck_ignore = [
# satre.xlsx is a local file that's copied into place, but since we treat the hyperlink
# as an external link (to bypass the :download: role that inserts a hash into the path)
# we need to exclude it from the linkchecker
r"satre\.xlsx",
]


# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
myst_enable_extensions = ["attrs_inline", "colon_fence", "deflist", "fieldlist"]

Expand Down

0 comments on commit 14ed04c

Please sign in to comment.