diff --git a/.gitignore b/.gitignore index 58f6dc80a..bf4c09a03 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ tmp/ .DS_Store *notes-from-review.md *.idea* +*venv* # Grammar / syntax checkers styles/ # Exclude translation .mo files diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 000000000..cf19ab497 --- /dev/null +++ b/.lycheeignore @@ -0,0 +1,4 @@ +# List of links to ignore -- see https://lychee.cli.rs/recipes/excluding-links/ +# +# All github.com links are excluded to avoid rate limiting +https://github.com/ diff --git a/conf.py b/conf.py index de9920210..b700094a6 100644 --- a/conf.py +++ b/conf.py @@ -205,6 +205,17 @@ # myst complains about bibtex footnotes because of render order suppress_warnings = ["myst.footnote"] +# -- Additional configuration for build process ------------------------------ + +# Use the default linkcheck ignore list +# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-linkcheck_ignore +# +# This is a list of regular expressions that match URIs to ignore when +# doing linkcheck. Make sure to use raw strings (r"") for regexes. Also, any added +# item should also be included in the .lycheeignore file. +linkcheck_ignore = [ + r"https://github.com/", +] def _post_build(app: "Sphinx", exception: Exception | None) -> None: rss.generate_tutorials_feed(app) @@ -215,3 +226,4 @@ def setup(app: "Sphinx"): # Parallel safety: https://www.sphinx-doc.org/en/master/extdev/index.html#extension-metadata return {"parallel_read_safe": True, "parallel_write_safe": True} +