Skip Menu |
 

From: kaduk@MIT.EDU
Subject: SVN Commit

Make sphinx warnings fatal for doc build

We currently do not have any warnings. Let us keep it that way by
making warnings fatal in maintainer-mode (and configurable on the
buildslaves). Using sphinx-build -W also causes errors to be reported
in the exit status and picked up by make, which is quite useful.

In order to allow the build bot to use -W but end-users to not use it,
SPHINX_ARGS must be passed on the command line; it cannot be set by
the convenience target 'htmlsrc'. Document this.

https://github.com/krb5/krb5/commit/7b6758a09f92ccc386022bcc86e3a5fea472fdce
Author: Ben Kaduk <kaduk@mit.edu>
Commit: 7b6758a09f92ccc386022bcc86e3a5fea472fdce
Branch: master
doc/build_this.rst | 2 +-
src/doc/Makefile.in | 5 +++--
2 files changed, 4 insertions(+), 3 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit

Make sphinx warnings fatal for doc build

We currently do not have any warnings. Let us keep it that way by
making warnings fatal in maintainer-mode (and configurable on the
buildslaves). Using sphinx-build -W also causes errors to be reported
in the exit status and picked up by make, which is quite useful.

In order to allow the build bot to use -W but end-users to not use it,
SPHINX_ARGS must be passed on the command line; it cannot be set by
the convenience target 'htmlsrc'. Document this.

(cherry picked from commit 7b6758a09f92ccc386022bcc86e3a5fea472fdce)

https://github.com/krb5/krb5/commit/c54a33b520afb8d1e7c6c37db15189185f220ada
Author: Ben Kaduk <kaduk@mit.edu>
Committer: Tom Yu <tlyu@mit.edu>
Commit: c54a33b520afb8d1e7c6c37db15189185f220ada
Branch: krb5-1.11
doc/build_this.rst | 2 +-
src/doc/Makefile.in | 5 +++--
2 files changed, 4 insertions(+), 3 deletions(-)