Chris Johns
33849946ff
Clean up sphinx warnings.
...
- Fix minor formatting issues.
- Fix reference the gloassary TLS using ':term:'.
- Make sure nothing is between an anchor and the heading where ':ref:' references
the anchor. This meant moving all the recently added '.. index::' entries.
Update #3232 .
Update #3229 .
2017-11-13 13:25:18 +11:00
Chris Johns
ac0eaff941
Use '.. toctree::' and not '.. include::' in the User Manual.
...
- Change all suitable '.. include::' to TOC tree.
- Remove unused and not needed sections.
- Fix the conf.py to not exclude some files.
Close #3232 .
2017-11-13 11:51:23 +11:00
Chris Johns
42d50d760e
Add indexes to all documents.
...
Update #3229 .
2017-11-12 10:32:39 +11:00
Sebastian Huber
60a6d6eae9
Change RTEMS version to 5
...
Update #3220 .
2017-11-09 10:24:09 +01:00
Chris Johns
efc29ff31b
Update copyright notices.
2017-08-11 13:45:52 +10:00
Tanu Hari Dixit
c475eeffdb
User Manual: Added rtems-tester in the docs
...
Added as part of Tools.
Made changes according to Chris' review
Also removed the ini format part inline with
the new release that is expected.
2017-06-14 11:38:47 +10:00
Chris Johns
eb934d0d6c
User: Remove conflict marker.
2017-06-01 11:44:34 +10:00
Chris Johns
32400785ce
User: Remove the stash conflict markers.
2017-05-31 21:11:01 +10:00
Chris Johns
d224b11688
User: Improvements to some of the tools commands.
2017-05-31 20:59:36 +10:00
Chris Johns
7f89df83f3
User Manual: Update the rtems-bsp-builder command.
2017-05-24 13:07:21 +10:00
Chris Johns
ad5d63277c
waf: Cleaner formatting to see the importing.
2017-03-27 10:25:25 +11:00
Chris Johns
10874b0937
user: Fix typo.
2017-03-21 11:41:40 +11:00
Chris Johns
8561c3ca74
user: Minor fixes to rtems-bsp-builder.
2017-03-21 11:37:09 +11:00
Chris Johns
e82055bfd5
user: Add an example of the rtems-bsp-builder running.
2017-03-21 10:32:18 +11:00
Chris Johns
f97be09daf
Use a single top level version number.
2017-03-20 12:18:53 +11:00
Chris Johns
1accbe31a5
user: Add tool commands to the user manual.
2017-03-15 15:03:41 +11:00
Joel Sherrill
7193f09294
Update document titles for consistency
2017-01-11 19:01:20 -06:00
Joel Sherrill
d8beaabd02
Remove references to SPARC/SIS BSP. Also clean up old ERC32 references.
...
updates #2810 .
2017-01-11 18:22:10 -06:00
Sebastian Huber
45dc7c7ba5
Update version/revision to 4.11.99
2016-12-21 11:32:51 +01:00
Chris Johns
aa1c010e31
user: Fix header levels.
2016-11-09 12:20:46 +11:00
Chris Johns
005f0e81ab
Fix spelling.
2016-11-02 15:19:42 +11:00
Chris Johns
dd43d0b0f8
waf: Add an install command.
2016-10-31 08:48:35 +11:00
Chris Johns
9dd79f289c
waf: Formatting.
2016-10-30 12:36:30 +11:00
Chris Johns
706a1e290f
user: Add comments about warnings we cannot remove.
2016-10-29 06:30:24 +11:00
Chris Johns
9fd14dda8a
user: Add comment to move to packages.
2016-10-29 05:32:30 +11:00
Joel Sherrill
8e59c997a8
ecosys/index.rst: Fix complixity spelling
2016-10-27 18:14:29 -05:00
Chris Johns
ba30a482cf
Fix the table and section numbering in the User,Hardware,Tiers section.
2016-07-06 15:03:38 +10:00
Chris Johns
8da3a62701
Add a Hardware section.
2016-07-06 14:59:00 +10:00
Chris Johns
b73ba927de
Update the glossary.
2016-07-06 14:57:47 +10:00
Chris Johns
ae7a139ad6
Add the RTEMS Kernel section back in.
2016-07-04 12:45:57 +10:00
Chris Johns
86518bd3dd
Reorganisse the User Manual to make it easier to navigate.
2016-07-04 12:30:09 +10:00
Chris Johns
489740f6a9
Set SPDX License Identifier in each source file.
2016-05-20 12:47:09 +10:00
Amar Takhar
170418af2d
Move images to a common directory.
2016-05-18 13:47:42 -04:00
Chris Johns
ea0777e4ee
Review changes from Chris Mayfield.
2016-05-02 20:51:27 -04:00
Chris Johns
aae09e24ae
Corrections from Worth Burruss. Many thanks.
2016-05-02 20:51:27 -04:00
Chris Johns
a34c157d08
Corrections from Worth Burruss. Many thanks.
2016-05-02 20:51:27 -04:00
Chris Johns
6958370ed9
Fix bad formatting that somehow went into the doco.
2016-05-02 20:51:27 -04:00
Chris Johns
dc234b58f4
Corrections from a review.
2016-05-02 20:51:27 -04:00
Chris Johns
c075916ddc
Corrections and improvements from Worth Burruss (thanks so much).
2016-05-02 20:51:27 -04:00
Chris Johns
21519275cc
Corrections.
2016-05-02 20:51:27 -04:00
Chris Johns
27bcdfbf57
Add a basics section to Getting Started. Rearrange the content.
2016-05-02 20:51:27 -04:00
Chris Johns
024e04034e
Start adding Getting Started guide's Released Version.
2016-05-02 20:51:27 -04:00
Chris Johns
5353914b84
Updates from user reviews.
2016-05-02 20:51:27 -04:00
Chris Johns
4e3cf2b2f8
Split installation into separate files.
2016-05-02 20:51:26 -04:00
Chris Johns
c05e43b4a3
User manual, devel install and windows install.
2016-05-02 20:51:26 -04:00
Amar Takhar
ed3794ea39
Add 'waf linkcheck' to check external references.
2016-05-02 20:51:25 -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