Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modified doc/make.py to run sphinx-build -b linkcheck #54265

Merged
merged 18 commits into from
Sep 19, 2023
Merged
Changes from 15 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
15 changes: 11 additions & 4 deletions doc/make.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@ def _sphinx_build(self, kind: str):

Parameters
----------
kind : {'html', 'latex'}
kind : {'html', 'latex', 'linkcheck'}

Examples
--------
>>> DocBuilder(num_jobs=4)._sphinx_build('html')
"""
if kind not in ("html", "latex"):
raise ValueError(f"kind must be html or latex, not {kind}")
if kind not in ("html", "latex", "linkcheck"):
raise ValueError(f"kind must be html or latex or linkcheck, not {kind}")
ggold7046 marked this conversation as resolved.
Show resolved Hide resolved

cmd = ["sphinx-build", "-b", kind]
if self.num_jobs:
Expand Down Expand Up @@ -288,6 +288,13 @@ def zip_html(self):
os.chdir(dirname)
self._run_os("zip", zip_fname, "-r", "-q", *fnames)

def linkcheck(self):
"""
Check for broken links in the documentation.
"""
ret_code = self._sphinx_build("linkcheck")
return ret_code
ggold7046 marked this conversation as resolved.
Show resolved Hide resolved


def main():
cmds = [method for method in dir(DocBuilder) if not method.startswith("_")]
ggold7046 marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -369,7 +376,7 @@ def main():
args.verbosity,
args.warnings_are_errors,
)
return getattr(builder, args.command)()
ggold7046 marked this conversation as resolved.
Show resolved Hide resolved



if __name__ == "__main__":
Expand Down
Loading