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

158 Commits

Author SHA1 Message Date
Chris Johns
204ac80935 sphinx: Use the pip installed sphinx-rtd-theme 
- Remove the RTEMS version of the theme

- Use conf.py to specify our style sheet

- Depend on the jQuery contrib package for including jQuery

- Detect the theme is installed

Closes #4994
 2024-02-21 07:44:36 -06:00
Chris Johns
e31a0b22fe sphinx/style: Fix building with the latest sphinx 
Tested on sphinx 7.2, 6.1.3 AND 5.3.0

Closes #4980
 2023-12-20 08:05:52 +11:00
Andrew Butterfield
2c88912893 eng: Add formal verification chapter 2023-11-09 13:44:36 +01:00
Joel Sherrill
fbcae10810 common/waf.py: Add option to check maximum Sphinx version 
Updates #4928.
 2023-07-25 15:20:22 -05:00
Joel Sherrill
13237ab34b layout.html: Revert patch forcing Spinx to >= 6.0 
Unfortunately, updating past Sphinx 5.x results in unordered bullet
lists not formatting correctly as show in a screen capture attached
to #4928. Revert this patch until the issue is resolved and output
is reviewed for other potential issues.

    From: Utkarsh Verma <utkarsh@bitbanged.com>
    Date: Wed, 14 Jun 2023 05:36:26 +0000
    Subject: [PATCH] eng: Fix builds for newer Sphinx versions (>=7)

    The current Sphinx theme depends on the `style` parameter which got
    deprecated in v5.1 and finally got removed in v7. Now, the `styles` key
    should be preferred which is a list of stylesheets. This commit
    implements this change.

Updates #4915.
Updates #4928.
 2023-07-25 15:20:12 -05:00
Utkarsh Verma
4c87f9b594 eng: Fix builds for newer Sphinx versions (>=7) 
The current Sphinx theme depends on the `style` parameter which got
deprecated in v5.1 and finally got removed in v7. Now, the `styles` key
should be preferred which is a list of stylesheets. This commit
implements this change.

Closes #4915
 2023-06-14 15:45:56 +10:00
Sebastian Huber
bbb8b7aa81 Update company name 
The embedded brains GmbH & Co. KG is the legal successor of embedded
brains GmbH.
 2023-05-20 11:12:29 +02:00
Chris Johns
8f5f371b3d waf: Handle the enable options for singlehtml and ditaa/puml 
Close #4756
 2022-12-07 08:33:41 +11:00
Chris Johns
10e8dcc0e6 pdf: Set TEXINPUTS to the tex source path 2022-08-12 16:03:46 +10:00
Chris Johns
c935a2c918 building: Add support for an RTEMS version number 
- Support using a version number for RTEMS documentation

Updates #4695
 2022-08-03 14:28:19 +10:00
Amar Takhar
fa25208342 Update jQuery from 1.12.4 to 3.6.0. 
Identified by security scans.
 2021-11-11 22:28:57 -05:00
Chris Johns
1568c2baa7 Fix the bibtex extension configure test 2021-05-21 16:47:19 +12:00
Chris Johns
1361d2cd30 Fix the linux specific include 2021-05-21 16:47:19 +12:00
Vijay Kumar Banerjee
998f8755e0 common/latex.py: use distro module for python3.5 and up 2021-03-30 09:28:59 -06:00
Gedare Bloom
20323829cf common/waf: fix some typos 2021-02-18 13:03:34 -07:00
Gedare Bloom
4563bb6a8b common: use bibtex_bibfiles for newer bibtex 
Closes #4229.
 2021-02-18 13:03:34 -07:00
Sebastian Huber
ddd4b1e7be common: Enable numfig role 2020-09-13 10:48:53 +02:00
Sebastian Huber
03e0601e4f common: Fix pale color of HTML definition terms 2020-08-07 08:46:14 +02:00
Sebastian Huber
6b52a48ac4 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-07-08 07:35:59 +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