rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-16 06:06:58 +08:00
Code Issues Packages Projects Releases Wiki Activity
576 Commits 3 Branches 7 Tags
Commit Graph

110 Commits

Author SHA1 Message Date
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
dec664b982 common/header: Add missing copyright notice 2019-01-11 10:39:51 +01:00
Sebastian Huber
65f54a95f1 Update header.rst 
Remove trailing slashes in URLs.  Fix bug reporting URL.
 2019-01-09 09:24:02 +01:00
Sebastian Huber
50fbe0d9b4 Add common header.rst to reduce copy and paste 2019-01-09 09:24:02 +01:00
Sebastian Huber
5631d58271 Remove superfluous word "Copyright" 
The © symbol is sufficient.
 2019-01-09 09:24:02 +01:00
Sebastian Huber
cd408b5a8b Update general copyright notice 
Update year and add "and contributors".
 2019-01-09 09:24:02 +01: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
Amar Takhar
ab839408f9 Add a README file containing the colours used in the RTEMS logo. 2018-10-24 13:41:04 -04:00
Chris Johns
969e60e596 Update the copyright year. 2018-10-19 14:42:12 +11:00
Chris Johns
859096bd78 waf: Fix type in single html build. 2018-08-21 14:54:41 +10:00
Chris Johns
471c5e380f pdf: Revert the changes to the Latex index formatting. 
I removed the '_' splitting of long labels from the index when testing
and this puts it back.
 2018-08-21 13:55:03 +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
5c3683e900 Improve the line spaces for directives and notes. 2017-09-14 21:50:35 +10:00
Sebastian Huber
5fc9f8bc42 common: Remove obsolete latex_use_parts 
This configuration is obsolete and no longer documented:

http://www.sphinx-doc.org/en/stable/config.html#options-for-latex-output

The use of parts at the top-level results in ugly documents.
 2017-08-25 14:28:27 +02:00
Chris Johns
feb68323b7 coverpage: Fix repeated entries. 
Closes #2865.
 2017-08-11 13:45:57 +10:00
Chris Johns
efc29ff31b Update copyright notices. 2017-08-11 13:45:52 +10:00
Chris Johns
c68461134e pdf: Update the RTEMS style to work recent Sphinx versions. 2017-08-11 13:45:47 +10:00
Chris Johns
7464b71b59 common/conf: Clean up. 2017-08-11 13:45:41 +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
e7f009e549 conf: Update the copyright year. 2017-03-21 08:41:55 +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
1accbe31a5 user: Add tool commands to the user manual. 2017-03-15 15:03:41 +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
Sebastian Huber
c1dddacbee Move extensions to common conf.py 2017-02-22 07:09:21 +01:00
Sebastian Huber
b033e3960b c-user: Add SMP application issues section 2017-02-02 10:46:05 +01:00
Sebastian Huber
7b1c63cf91 c-user: Update clustered scheduling 2017-02-02 09:43:47 +01:00
Sebastian Huber
3966353b33 Do not show page references after internal links 2017-02-01 09:48:31 +01:00
Sebastian Huber
5dcebd4f62 Fix refs.bib entries 2017-02-01 07:58:30 +01:00
Sebastian Huber
8add1793d2 c-user: Add Key concept locking protocols 
Update #2412.
Update #2556.
 2017-02-01 07:58:30 +01:00
Sebastian Huber
938c49e177 Fix refs.bib entry 2017-01-31 14:30:09 +01:00
Sebastian Huber
a17535d222 c-user: Add timer and timeouts key concept 
Update #2554.
 2017-01-30 13:52:23 +01:00
Sebastian Huber
73ad65dff0 refs.bib: Add URL 2017-01-30 08:11:37 +01:00
Kuan-Hsun Chen
c660173fa4 c-user: Update overrun handling related functions and structure 
State the limited count of postponed_jobs.
Update _rtems_rate_monotonic_get_status() and related structure.
Move "Further Reading" in c-user to references.
Add mentioned papers in ticket #2795 to references.

Update #2795.
 2017-01-30 07:58:27 +01:00
Sebastian Huber
0456ee759a Fix some reference titles 2017-01-25 08:36:41 +01:00
Sebastian Huber
f5e8e8068f Sort references 2017-01-25 08:26:39 +01:00
Sebastian Huber
97e1553c06 c-user: Add support for references via bibtex 
https://sphinxcontrib-bibtex.readthedocs.io/en/latest/index.html

Update #2871.
 2017-01-18 11:31:46 +01:00
Chris Johns
7956bbffef coverpage: Remove used function. 2017-01-12 13:20:48 +11:00
Chris Johns
321d20a02d coverpage: Make showing the table conditional. 2017-01-12 13:18:43 +11:00
Chris Johns
bceb2860b7 coverpage: Rename the static images directory to match bootstrap. 2017-01-12 13:11:34 +11:00
Chris Johns
9eb8a437bd coverpage: Fix the catalogue table id. 2017-01-12 13:07:13 +11:00