diff options
author | Chris Johns <chrisj@rtems.org> | 2017-03-27 10:31:13 +1100 |
---|---|---|
committer | Chris Johns <chrisj@rtems.org> | 2017-03-27 10:31:13 +1100 |
commit | 33989b6bf63afe7ec04649f6b9e96294026fda64 (patch) | |
tree | e71d33490c9ccf7b925d13f4f91185a789d948c2 | |
parent | waf: Fix linkcheck and spell commands. (diff) | |
download | rtems-docs-33989b6bf63afe7ec04649f6b9e96294026fda64.tar.bz2 |
Add Windows build details.
Actually include the quoting fix for Windows.
-rw-r--r-- | README.txt | 23 | ||||
-rw-r--r-- | common/waf.py | 2 |
2 files changed, 24 insertions, 1 deletions
@@ -65,6 +65,29 @@ and sphinx: export PATH=/usr/local/texlive/2016/bin/i386-linux/:${PATH} export PATH=${HOME}/.local/bin:${PATH} +Windows +~~~~~~~ + +To build the documentation on Windows you need to install an offical Python +build from https://www.python.org/. We suggest you install a recent 2.7 series +64bit build. The versions 2.7.9 and after include pip. + +Note: you cannot use the MSYS2 versions of Python because the pip libraries +that contain C or C++ code are built with MSVC libraries and cannot integrate +with the MSYS2 built python. + +The following assumes Python is installed to its default path of C:\Python27. + +Open an MSYS2 terminal window and add the needed paths to Python and its +scripts: + + $ export PATH=/c/Python27/Scripts:/c/Python27:$PATH + +Install Sphinx and any needed extensions: + + $ pip install sphinx + $ pip install sphinxcontrib-bibtex + FreeBSD ~~~~~~~ diff --git a/common/waf.py b/common/waf.py index 7845f05..7947829 100644 --- a/common/waf.py +++ b/common/waf.py @@ -22,7 +22,7 @@ def build_date(): return '%s %s %s' % (d, m, y) def version_cmdline(ctx): - return "-Drelease='%s' -Dversion='%s'" % (ctx.env.VERSION, ctx.env.VERSION) + return '-Drelease="%s" -Dversion="%s"' % (ctx.env.VERSION, ctx.env.VERSION) def sphinx_cmdline(ctx, build_type, conf_dir, doctrees, source_dir, output_dir): rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s" % \ |