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

Treat sphinx warnings as errors #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Treat sphinx warnings as errors #4

Show file tree
Hide file tree
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
19 changes: 14 additions & 5 deletions doc_builder/build_commands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@ def get_build_dir(build_dir=None, repo_root=None, version=None):

return build_dir

def get_build_command(build_dir, run_from_dir, build_target, num_make_jobs, docker_name=None):
def get_build_command(build_dir, run_from_dir, build_target, num_make_jobs, docker_name=None,
warnings_as_warnings=False,
):
"""Return a string giving the build command.

Args:
Expand All @@ -80,7 +82,9 @@ def get_build_command(build_dir, run_from_dir, build_target, num_make_jobs, dock
if docker_name is None:
return _get_make_command(build_dir=build_dir,
build_target=build_target,
num_make_jobs=num_make_jobs)
num_make_jobs=num_make_jobs,
warnings_as_warnings=warnings_as_warnings,
)

# But if we're using Docker, we have more work to do to create the command....

Expand All @@ -107,7 +111,9 @@ def get_build_command(build_dir, run_from_dir, build_target, num_make_jobs, dock

make_command = _get_make_command(build_dir=docker_build_dir,
build_target=build_target,
num_make_jobs=num_make_jobs)
num_make_jobs=num_make_jobs,
warnings_as_warnings=warnings_as_warnings,
)

docker_command = ["docker", "run",
"--name", docker_name,
Expand All @@ -119,7 +125,7 @@ def get_build_command(build_dir, run_from_dir, build_target, num_make_jobs, dock
DOCKER_IMAGE] + make_command
return docker_command

def _get_make_command(build_dir, build_target, num_make_jobs):
def _get_make_command(build_dir, build_target, num_make_jobs, warnings_as_warnings):
"""Return the make command to run (as a list)

Args:
Expand All @@ -128,7 +134,10 @@ def _get_make_command(build_dir, build_target, num_make_jobs):
- num_make_jobs: int: number of parallel jobs
"""
builddir_arg = "BUILDDIR={}".format(build_dir)
return ["make", builddir_arg, "-j", str(num_make_jobs), build_target]
sphinxopts = "SPHINXOPTS="
if not warnings_as_warnings:
sphinxopts += "-W --keep-going"
return ["make", sphinxopts, builddir_arg, "-j", str(num_make_jobs), build_target]

def _docker_path_from_local_path(local_path, docker_mountpoint, errmsg_if_not_under_mountpoint):
"""Given a path on the local file system, return the equivalent path in Docker space
Expand Down
7 changes: 6 additions & 1 deletion doc_builder/build_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ def commandline_options(cmdline_args=None):
help="Number of parallel jobs to use for the make process.\n"
"Default is 4.")

parser.add_argument("-w", "--warnings-as-warnings", action="store_true",
help="Treat sphinx warnings as warnings, not errors.")

options = parser.parse_args(cmdline_args)
return options

Expand Down Expand Up @@ -172,5 +175,7 @@ def main(cmdline_args=None):
run_from_dir=os.getcwd(),
build_target=opts.build_target,
num_make_jobs=opts.num_make_jobs,
docker_name=docker_name)
docker_name=docker_name,
warnings_as_warnings=opts.warnings_as_warnings,
)
run_build_command(build_command=build_command)