30 Commits

Author SHA1 Message Date
Chris Johns
1e9f28ceeb waf: Add a title to the XML Catalogue. 2017-01-10 22:38:32 +11:00
Chris Johns
f08d4c194b waf: Improved XML Catalogue generator. 2017-01-10 22:38:28 +11:00
Chris Johns
916d29532f waf: Create an XML Catalogue. 2017-01-10 22:38:23 +11:00
Chris Johns
9330bfbaa7 waf: Users without the extra fonts need to use '--disable-extra-fonts' to build PDF. 2016-11-09 17:08:05 +11:00
Chris Johns
2fdbc9826f waf: Use the good fonts if installed. 2016-11-08 15:58:58 +11:00
Chris Johns
8330198edc waf: Add support to handle missing Latex packages on hosts they are not available on.
It appears the support for texlive packages on some hosts is variable. This patch
lets us add missing packages to our source tree so a PDF can be built on
those hosts. The quality of the PDFs created may vary as some short cuts may
have been take. For example lato is a font and only the sty file as been added
and not the actual font which means it's use will default to another font.
2016-11-06 12:02:47 +11:00
Chris Johns
74194f7538 waf: Check for texlive packages and report an error is not found. 2016-11-04 16:22:42 +11:00
Chris Johns
9024cfbc7f waf: Fix the bnode issue when building in a manual directory. 2016-11-04 08:44:37 +11:00
Chris Johns
6207c37d9c waf: Use separate doctrees so avoid sphinx clashes. 2016-11-03 15:22:49 +11:00
Chris Johns
0bc9c6d3de waf: Have configure set building pdf and/or singlehtml.
Move selecting pdf and singlehtml to the configure stage so it
is sticky for all builds. This means a top level build will always
build all formats that have been configured.

Do not complete the configure stage if tools are missing for the
configured output.

Add singlehtml support using the inliner tool. It is nice.

Remove the groups as waf can track the dependences. This lets the
manuals build in parallel.
2016-11-03 14:30:47 +11:00
Chris Johns
8f2a4f3959 waf: Fix the sphinx verbose option. 2016-11-02 12:07:50 +11:00
Chris Johns
dd43d0b0f8 waf: Add an install command. 2016-10-31 08:48:35 +11:00
Chris Johns
f529417387 waf: Add top build support. 2016-10-30 12:36:30 +11:00
Chris Johns
f3a7c9641b waf: Update to support a recent waf. 2016-10-29 04:16:38 +11:00
Joel Sherrill
be428d186c common/waf.py: Improve Sphinx version parsing to work with their git master 2016-10-27 18:03:34 -05:00
Chris Johns
a545490518 waf: Fix for waf-1.9.3. 2016-09-09 14:08:48 +10:00
Amar Takhar
170418af2d Move images to a common directory. 2016-05-18 13:47:42 -04:00
Amar Takhar
2bcd424b4b Switch to using Minted and splitting long lines in verbatim. 2016-05-02 20:51:26 -04:00
Chris Johns
0858375b5a Run through 2to3. 2016-05-02 20:51:26 -04:00
Chris Johns
0f5ccd4d6d Generate a fatal error on a Sphinx beta version that cannot be parsed. 2016-05-02 20:51:25 -04:00
Amar Takhar
ed3794ea39 Add 'waf linkcheck' to check external references. 2016-05-02 20:51:25 -04:00
Amar Takhar
9b495a2980 Remove incorrect pdflatex/makeindex check. 2016-05-02 20:51:25 -04:00
Amar Takhar
7c1f2154d6 Only require makeindex and pdflatex when trying to build PDF. 2016-05-02 20:51:25 -04:00
Amar Takhar
a316b1ff6d Add support for singlehtml (inlined) HTML file, plus some other fixes.
* This is still broken.
  * Rename sphinx_rtd_theme so it doesn't pickup locally installed ones
  * Add a hack to theme.css to get around inliner bug.
  * Some unrelated fixups in common/waf.py

Unfortunatly several dozen fixes got merged into this.
2016-05-02 20:51:25 -04:00
Amar Takhar
89f234787e Fix typo and add another dependency. 2016-05-02 20:51:24 -04:00
Amar Takhar
14bbcb1ea9 Add minimum version check for Sphinx.
Some distributions have ancient versions we require at least 1.3.
2016-05-02 20:51:24 -04:00
Amar Takhar
9b5801a6e6 Add PDF generation support use with --pdf 2016-05-02 20:51:24 -04:00
Amar Takhar
f916fcaaae Add support for spellchecking with a custom dictionary.
To use:

  1. Install aspell
  2. waf spell <list of files>
     * waf spell mydoc.rst
     * waf spell *.rst

This uses a custom dictionary stored in common/spell/dict/.  We should add all
RTEMS and programming terms to this to ensure we are consistent.

Amar.
2016-05-02 20:51:24 -04:00
Amar Takhar
3a717592a9 Rework how conf.py is handled.
Needed to switch due to increasing complexity.
2016-05-02 20:51:24 -04:00
Amar Takhar
5daabd23cf Initial reST documentation using Sphinx. 2016-05-02 20:51:07 -04:00