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
Sebastian Huber
45dc7c7ba5
Update version/revision to 4.11.99
2016-12-21 11:32:51 +01:00
Chris Johns
5431beb472
filesystem: Fix header levels.
2016-11-09 16:54:02 +11:00
Joel Sherrill
790fcab1d5
filesystem: Fix numbered lists.
2016-10-28 15:56:47 -05:00
Joel Sherrill
30c32cbc4c
in-memory.rst, mounting_and_unmounting.rst: Remove unnecessary backslash
2016-10-28 14:51:54 -05:00
Chris Johns
23a5ce4498
Remove the old files.
2016-10-29 05:09:35 +11:00
Chris Johns
4cacea0963
Fix filesystem formatting.
2016-10-27 18:03:57 -07:00
Chris Johns
489740f6a9
Set SPDX License Identifier in each source file.
2016-05-20 12:47:09 +10:00
Amar Takhar
ed3794ea39
Add 'waf linkcheck' to check external references.
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
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
14d532bb65
Fix section numbering, create TOC, seperate preface.
2016-05-02 20:51:22 -04:00
Amar Takhar
aa3dcf4eb2
Rename old document for reference only.
2016-05-02 20:51:22 -04:00
Amar Takhar
2d1dc3fe73
Split document into seperate files by section.
2016-05-02 20:51:22 -04:00
Amar Takhar
c142f5b338
Fix markup warnings.
2016-05-02 20:51:22 -04:00
Amar Takhar
5daabd23cf
Initial reST documentation using Sphinx.
2016-05-02 20:51:07 -04:00
