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

140 Commits

Author SHA1 Message Date
Sebastian Huber
17aca24105 common: Remove probably superfluous import 
The purpose of this import is unclear.

This import caused the following error with Sphinx 3.0:

Extension error:
Could not import extension rtemsdomain (exception: cannot import name 'l_')
 2020-08-10 11:42:11 +02:00
Gedare Bloom
fb3644c14b common: fix title page 
Sphinx changed the default behavior of maketitle. Provide our
own rtemsmaketitle command and use it instead.
 2020-04-04 10:14:47 +11:00
Chris Johns
d514e3308e waf: User friendly message when no sphinx is installed 2020-04-03 11:11:11 +11:00
Chris Johns
19af6b47d5 waf: Get the version numbers from the version file. 2020-03-13 08:18:36 +11:00
Chris Johns
5bd9f4dff4 sphinx: Add a custom highlight colour 
Update #2998
 2020-03-13 08:18:36 +11:00
Amar Takhar
9845183527 Update sphinx_rtd_theme to https://github.com/readthedocs/sphinx_rtd_theme/ 
68a19ca / 0.4.3.dev0. I have been using this one for a while without
issues.

This should fix the search issues.

closes #3880
 2020-02-26 00:09:17 -05:00
Sebastian Huber
d9d9c700a2 Revert "common: Add URLs to manuals" 
This reverts commit 1fdd3cf83d154af66ad0edf5094d93075063c7e0 and some
follow up changes.
 2020-02-04 05:45:02 +01:00
Sebastian Huber
1fdd3cf83d common: Add URLs to manuals 2020-01-07 07:19:50 +01:00
Chris Johns
c576e9bf0d waf/common: Fix UTF-8 encoding of HTML inliner output on Python3. 2019-10-29 13:37:43 +11:00
Sebastian Huber
5d7921bebc common: Show page references after internal links 
The custom RTEMS extension produced quite verbose references like
"Chapter 3 - Section 7 - Bla blub".  This may distract the reading flow.
Use a standard Sphinx option to show page references instead, e.g. "Bla
blub (page 11)".  This has some value for printed out documents.
 2019-08-14 07:27:00 +02:00
Sebastian Huber
8037cbbebc common: Align "Build Logs" with other list names 2019-08-05 15:08:53 +02:00
Sebastian Huber
78889043eb refs: Update EARS references 2019-07-24 10:50:18 +02:00
Sebastian Huber
d4670fee81 refs: Add ECSS standard references 
Add the ECSS standards in a separate block.  Use a custom label scheme
to make citations easier.
 2019-07-23 09:40:43 +02:00
Sebastian Huber
e8592425b5 refs: Replace non-ASCII character 2019-07-23 09:40:03 +02:00
Sebastian Huber
a1d63745d9 common: Add references 2019-07-11 09:02:44 +02:00
Sebastian Huber
5a51c73130 c-user: Add RTEID and ORKID references 2019-06-21 07:44:50 +02:00
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
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
4407039110 waf: Fix building the images in the src path. 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
Joel Sherrill
603731cda8 common/latex.py: Remove hack for CentOS. Use Texlive per instructions. 2019-02-13 16:16:38 -06:00
Chris Johns
7b36a6b60d waf: Use the release date in the coverpage 2019-02-14 07:47:30 +11:00
Chris Johns
d721375610 waf: Fix version.py to support older versions of git. 2019-02-13 10:56:19 +11:00
Chris Johns
ec95748f03 Remove minted from the PDF builds. 
This is feedback from the Sphinx project. See:

https://github.com/sphinx-doc/sphinx/issues/6021#issuecomment-460951653
 2019-02-13 08:52:01 +11:00
Chris Johns
6f18d69633 Fix the version logic to make it more robust. 2019-02-07 08:46:53 +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
Chris Johns
2a68e9d425 Support VERSION file for releasing and deployment 
- Shorten the GIT hash.
 2019-02-06 17:01:48 +11:00
Sebastian Huber
d9eb36b097 Change first copyright year to 1988 
The OAR copyright goes back to 1988.
 2019-01-18 09:54:36 +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
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