From ac542c2f0bf79cfc302b0fb7059adbbc6bdf60f0 Mon Sep 17 00:00:00 2001 From: buckE Date: Fri, 26 Jun 2020 04:13:40 +0000 Subject: removed exit 1 on sphinx warnings --- Makefile | 7 +++---- README | 4 ++++ 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index da61fa46..358aef58 100644 --- a/Makefile +++ b/Makefile @@ -60,8 +60,8 @@ diagrams: arch-api.png # The html-linked builder does not support caching, so we # remove all cached state first. html: diagrams -# -W = exit 1 on warning; --keep-going = complete build anyway; write log to ~/warnings.log - $(SPHINXBUILD) -W --keep-going -b html-linked $(ALLSPHINXOPTS) $(BUILDDIR)/html +# -W = exit 1 on warning; --keep-going = complete build anyway; -w /tmp/sphinx-warnings.log = write log to ~/warnings.log + $(SPHINXBUILD) -b html-linked $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." @@ -122,8 +122,7 @@ latex: "(use \`make latexpdf' here to do that automatically)." latexpdf: - # -W = exit 1 on warning; --keep-going = complete build anyway - $(SPHINXBUILD) -W --keep-going -w $(shell echo $HOME)/logs/sphinx-warnings.log -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." diff --git a/README b/README index 55a9c430..b7f64144 100644 --- a/README +++ b/README @@ -4,3 +4,7 @@ Before building the documentation, make sure that you have the required dependencies installed using pip3: $ pip3 install --user --upgrade recommonmark sphinx + +Note by Buck: when setting up on VM, I also needed: + +# apt install texlive-latex-extra graphviz -- cgit v1.2.3