From 62efd4c041e2e7112d7d192ad343a2af9d9b2a2f Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Wed, 20 Feb 2019 10:11:37 +1100 Subject: waf: Change --sphinx-verbose to --sphinx-options, add --sphinx-nit-pick Provide options to manage sphinx. Make using the nit-picky mode simpler to access. --- README.txt | 44 ++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 4 deletions(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index b1a5978..ed05fb8 100644 --- a/README.txt +++ b/README.txt @@ -45,9 +45,21 @@ All images should be placed int he 'images' directory and referenced from the ReST with a relative path. This lets us shared and control images. We prefer being able to build images from source. This is not always possible -so SVG format is preferred with generated PNG images so make sure the quality +so SVG format is preferred with generated PNG images to make sure the quality is consistent when building PDF output. +Building images requires the source with an apporoiate file extension +is placed in the images directory. The built output image is written +back to the images directory. All images may be built or rebuilt when +building images is enabled via the waf configure command line. Please +only add and commit those images that have changed. + +We support building images in: + +1. PlantUML (.puml), enable with `--plantuml` + +2. Ditaa (.ditaa), enable with `--ditaa` + We support the PlantUML image language. The PlantUML home page is: http://plantuml.com/ @@ -326,12 +338,26 @@ Note: waf-1.9.5 is a little noisy when running tex builds and tests. I hope To build enter in the top directory: $ ./waf configure [--pdf] [--singlehtml] [--prefix] \ - [--sphinx-verbose] [--disable-extra-fonts] + [--sphinx-options] \ + [--sphinx-nit-pick] \ + [--plantuml] \ + [--ditaa] \ + [--disable-extra-fonts] + $ ./waf The '--pdf' and '--singlehtml' options can be added to configure to build those output formats. +Sphinx options can be added using the `--sphinx-options` option. If you have +more than option use a quoted argument. This is an advanced feature that can +be useful when experimenting with the `sphinx-build` command. + +Sphinx nit-picky mode adds `-n` to the `sphinx-build` command line to generate +warnings and extra information about the source to help make sure our +documentation source is as clean as possible. Please use this when writing +documentation or making updates. + The '--disable-extra-fonts' allows you to build PDF documents with out the fonts we use for a better quality document. Use this option to build without needing the extra fonts accepting you will get poor quality documents. @@ -341,10 +367,20 @@ To build and install to a specific location: $ ./waf configure --prefix=/foo/my/location $ ./waf build install +To build the PlantUML and Ditaa images: + + $ ./waf configure --plantuml --ditaa + $ ./waf clean build + +To nit-pick the source use: + + $ ./waf configure --sphinx-nit-pick + $ ./waf clean build + If you need to debug what is happening use configure with a suitable Sphinx -version level: +verbose level: - $ ./waf configure --sphinx-verbose=-v + $ ./waf configure --sphinx-options "-V -V" $ ./waf clean build You can enter a manual's directory and run the same configure command and build -- cgit v1.2.3