rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-15 02:47:44 +08:00
Code Issues Packages Projects Releases Wiki Activity
652 Commits 3 Branches 7 Tags
Commit Graph

52 Commits

Author SHA1 Message Date
Chris Johns
1393ba0c97 waf: Fix argument bug getting extra source. 2019-03-01 13:06:11 +11:00
Chris Johns
1a051fcd7c waf: Add support for extra and excluded sources. 2019-02-28 10:22:54 +11:00
Chris Johns
62efd4c041 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.
 2019-02-28 10:22:54 +11:00
Chris Johns
4407039110 waf: Fix building the images in the src path. 2019-02-28 10:22:54 +11:00
Chris Johns
a3b0a40880 Fix building with Sphinx 1.8 and later. 
- Provide the pytnon.ist file for makeindex.

- Add support for xelatex building so we can switch if we want too.

Closes #3669
 2019-02-06 17:02:18 +11:00
Sebastian Huber
3202e319a1 Replace build date with Git hash and commit date 
The usage of a build date prevents reproducible builds.
 2019-01-09 09:23:58 +01:00
Christian Mauderer
a7dc08331a common/waf.py: Fix indentation. 
Python 3 produces an error if indentation is mixed tabs and spaces.
 2018-12-18 18:45:00 +01:00
Amar Takhar
a46b0250e5 Fix error messages when Sphinx version cannot be checked. 
This is kind of a dual-check since it checks for the version while simultaneously
checking to see if Sphinx exists on the system.

Changed the error messages to be clear on the error and removed a reference to
version which cannot be set due to the check failure.

Reported by: Shashvat Jain
 2018-12-05 14:31:53 -05:00
Chris Johns
21c1a4492a waf: Add support to build PlantUML and Ditaa images. 2018-11-03 16:36:32 +11:00
Chris Johns
859096bd78 waf: Fix type in single html build. 2018-08-21 14:54:41 +10:00
Chris Johns
5ce8e43506 build: Fix indexing so it works on HTML and PDF. 
- Remove all genindex.rst files, these are generated and should not
  exist in our source.
- Fix the HTML templates so the local specialisation works.
- Add a index link to the sidebar for HTML.

Note, there is no TOC entry for the index in the PDF output and I
cannot figure out how to add one.

Closes #3503
 2018-08-21 13:47:40 +10:00
Richard Campbell
2a0664402b RTEMS Docs: Check sphinx version 
Sphinx.util.compat module was removed at Sphinx version 1.7.
Imported module was not being used.

Closes #3311.
 2018-03-09 13:28:45 -06:00
Chris Johns
8e8094abc8 build: Add extra source to the sphinx build. 
Updates #3177.
 2017-10-12 20:25:20 -05:00
Chris Johns
feb68323b7 coverpage: Fix repeated entries. 
Closes #2865.
 2017-08-11 13:45:57 +10:00
Chris Johns
58de62d8be Revert "Add the sphinxcontrib.bibtex extension to the repo." 
This reverts commit aa4f8e2e436d6c49e1524a4a3fb164b28632d894.

The contrib has too many dependencies to add into the repo.
 2017-08-09 20:19:22 +10:00
Chris Johns
aa4f8e2e43 Add the sphinxcontrib.bibtex extension to the repo. 2017-08-07 21:58:52 +10:00
Chris Johns
33989b6bf6 Add Windows build details. 
Actually include the quoting fix for Windows.
 2017-03-27 10:31:13 +11:00
Chris Johns
02635812f6 waf: Fix linkcheck and spell commands. 
Clean up and remove code that is not needed.

Fix sphinx-build quoting to work on Windows.
 2017-03-27 10:27:29 +11:00
Chris Johns
228560fdf2 waf: Create the sphinx rule in one place. 2017-03-21 08:41:41 +11:00
Chris Johns
f97be09daf Use a single top level version number. 2017-03-20 12:18:53 +11:00
Chris Johns
91d6c96b4c waf: Configure check the inliner only once. 2017-03-15 15:03:10 +11:00
Chris Johns
ff9d55501f Add a check for Sphinx extensions. 
Minor clean up of the configure messages.

Do not re-check sphinx in the nested configures.
 2017-02-25 15:05:09 +11:00
Chris Johns
9aa52b9130 waf: Add a title to the XML Catalogue. 2017-01-10 22:34:47 +11:00
Chris Johns
782b4fec71 waf: Improved XML Catalogue generator. 2017-01-10 10:11:05 +11:00
Chris Johns
1a9b02e20d waf: Create an XML Catalogue. 2017-01-09 23:13:02 +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