137 Commits

Author SHA1 Message Date
Chris Johns
ce4daf9fd9 Add a copyright to the PDF front page. 2016-11-02 16:34:32 +11:00
Chris Johns
75e787d4a0 html: Update the CSS and add topics. 2016-11-02 12:08:27 +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
761b082f37 waf: Add a build date to the copyright. 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
Chris Johns
f92357f36e Make the Warning colours match the theme. 2016-07-04 12:30:34 +10:00
Amar Takhar
170418af2d Move images to a common directory. 2016-05-18 13:47:42 -04:00
Chris Johns
5353914b84 Updates from user reviews. 2016-05-02 20:51:27 -04:00
Chris Johns
ad4229169c Remove the minted gobble. 2016-05-02 20:51:26 -04:00
Amar Takhar
2bcd424b4b Switch to using Minted and splitting long lines in verbatim. 2016-05-02 20:51:26 -04:00
Amar Takhar
63eaa6fbf0 Add Minted 2015/12/21 v2.2dev (ce7a111) 2016-05-02 20:51:26 -04:00
Chris Johns
c21e8e96ae Better error message, add FTP to the URL list. 2016-05-02 20:51:26 -04:00
Chris Johns
867016de12 Format the index for PDF output. 2016-05-02 20:51:26 -04:00
Chris Johns
0858375b5a Run through 2to3. 2016-05-02 20:51:26 -04:00
Amar Takhar
1ea5fb7293 Wrap \tabulary environment to allow breaking underscores.
* This \discretionary to avoid language issues.
2016-05-02 20:51:26 -04:00
Chris Johns
eccd84e752 Add wrap support to long table entries. 2016-05-02 20:51:25 -04:00
Chris Johns
859f0b7319 Add an rtems-table class to wrap and align HTML tables. 2016-05-02 20:51:25 -04:00
Chris Johns
7130ed3229 Fix PDF layout. 2016-05-02 20:51:25 -04:00
Chris Johns
c18d76ae55 Add my-style.css support and add RTEMS to that CSS. 2016-05-02 20:51:25 -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
0abc59dffc Add .svg logos for RTEMS that I made myself.
One is plain SVG the other has the Inkscape metadata in it.
2016-05-02 20:51:24 -04:00
Amar Takhar
2643223689 Add logo.pdf for PDF documents. 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
46498bd4e3 Fix rtemsconfig building.
I'll probably move to a more pythonic way of doing conf.py since this is getting
too complicated.
2016-05-02 20:51:24 -04:00
Amar Takhar
5daabd23cf Initial reST documentation using Sphinx. 2016-05-02 20:51:07 -04:00