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.

Sign up for GitHub

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

Jump to bottom

Automatic PR for 9ce16967-b74a-44f1-9266-16c5ef12843c #26

Open
wants to merge 1 commit into
base: 9ce16967-b74a-44f1-9266-16c5ef12843c-base
Choose a base branch
from
Open

Automatic PR for 9ce16967-b74a-44f1-9266-16c5ef12843c #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 4 additions & 10 deletions doc/make.py
View file
Open in desktop
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', 'linkcheck'}
kind : {'html', 'latex'}

Examples
--------
>>> DocBuilder(num_jobs=4)._sphinx_build('html')
"""
if kind not in ("html", "latex", "linkcheck"):
raise ValueError(f"kind must be html, latex or linkcheck, not {kind}")
if kind not in ("html", "latex"):
raise ValueError(f"kind must be html or latex, not {kind}")

cmd = ["sphinx-build", "-b", kind]
if self.num_jobs:
Expand Down Expand Up @@ -288,12 +288,6 @@ 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.
"""
return self._sphinx_build("linkcheck")


def main():
cmds = [method for method in dir(DocBuilder) if not method.startswith("_")]
Expand Down Expand Up @@ -379,4 +373,4 @@ def main():


if __name__ == "__main__":
sys.exit(main())
sys.exit(main())