29 Commits

Author SHA1 Message Date
Chris Johns
fb72a002a3 Add unicode support for commonly used characters like copyright.
- This change makes the copyright character easier to see on editors
  lacking good unicode rendering support, ie terminals.
2019-02-28 10:22:54 +11:00
Chris Johns
f7384cc2e2 Use pathto() on the genindex URL to make it relative. 2019-02-15 09:40:50 +11:00
Chris Johns
5d8b0ddd0a waf: Remove as many sys path hacks as we can.
There are still sys.path hacks in the conf.py files. They cannot
be removed because the instance of python running the sphinx-build
command does not see our top level path hacks. I looked at using
PYTHONPATH but I could not figure out how to set a process environ
var for a waf build instance.
2019-02-13 10:18:43 +11:00
Sebastian Huber
6f110ccf6b build: Prepend project common path
This avoids conflicts with standard packages such as PIL (Python Imaging
Library).
2019-02-08 09:43:16 +01:00
Sebastian Huber
b5014fe0c8 Reformat and update copyright and license notices
For everything before 2015 an OAR copyright is assumed.  Later copyright
notices are based on Git commits on a best effort basis.

The copyright notices of the "RTEMS Software Engineering Handbook" and
the "RTEMS CPU Architecture Supplement" are incomplete.
2019-01-14 07:15:27 +01:00
Sebastian Huber
e52906b556 Simplify SPDX-License-Identifier comment 2019-01-11 07:22:01 +01:00
Sebastian Huber
12dccfe716 Remove superfluous "All rights reserved." 2019-01-11 07:18:56 +01:00
Sebastian Huber
4886d60aa8 Use standard format for copyright lines 2019-01-11 07:18:16 +01:00
Sebastian Huber
50fbe0d9b4 Add common header.rst to reduce copy and paste 2019-01-09 09:24:02 +01:00
Chris Johns
969e60e596 Update the copyright year. 2018-10-19 14:42:12 +11: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
Chris Johns
42d50d760e Add indexes to all documents.
Update #3229.
2017-11-12 10:32:39 +11:00
Chris Johns
efc29ff31b Update copyright notices. 2017-08-11 13:45:52 +10:00
Chris Johns
ad5d63277c waf: Cleaner formatting to see the importing. 2017-03-27 10:25:25 +11:00
Chris Johns
f97be09daf Use a single top level version number. 2017-03-20 12:18:53 +11:00
Joel Sherrill
7193f09294 Update document titles for consistency 2017-01-11 19:01:20 -06:00
Joel Sherrill
7497f5ed9a porting: Review and tidy up multiple formatting issues. 2016-10-28 15:57:11 -05:00
Chris Johns
23a5ce4498 Remove the old files. 2016-10-29 05:09:35 +11:00
Joel Sherrill
b0f29772e2 porting: Fix code-block markup 2016-10-27 20:01:47 -05:00
Joel Sherrill
36def9125c rtems-docs: Fix many unnecessary back slashes 2016-10-27 19:47:07 -05:00
Chris Johns
489740f6a9 Set SPDX License Identifier in each source file. 2016-05-20 12:47:09 +10: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
d389819eea Convert all Unicode to ASCII(128) 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
0aa6200eff Rename old document for reference only. 2016-05-02 20:51:23 -04:00
Amar Takhar
6733466adf Split document into seperate files by section. 2016-05-02 20:51:23 -04:00
Amar Takhar
7526578599 Fix markup 2016-05-02 20:51:23 -04:00
Amar Takhar
5daabd23cf Initial reST documentation using Sphinx. 2016-05-02 20:51:07 -04:00