RTEMS / Documentation / Documentation

Go to Issues or Merge Requests

Issues

135 - Theme error building docs on 5 branch (opened)

Id

135

State

opened

Type

ISSUE

Author

Chris Johns

Assignee(s)

Chris Johns

Created

2026-02-20T04:31:52.290Z

Updated

2026-08-08T05:27:52.282Z

Milestone

5.4

Labels

doc::sphinx

Link

https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/135

Merges

0

Documentation does not build with the packages used on main . The error is:

Theme error:
An error happened in rendering the page index.
Reason: UndefinedError("'style' is undefined")

The 6 branch builds but that has a different theme.

Author: Chris Johns

2026-02-20T04:31:52.433Z

added rtems#14 as parent epic

Author: Chris Johns

2026-02-20T04:31:52.514Z

set status to To do

Author: Kinsey Moore

2026-02-20T14:33:01.359Z

Apparently modern versions of sphinx (7 or greater) have dropped the usage of “style” as it is now a keyword, so documentation must be updated. I have a potential fix, but I don’t have the ability to test on historical systems that would have used the original syntax to see if it still works.

Author: Kinsey Moore

2026-02-20T14:38:41.862Z

There is an additional issue if running on python 3.12 or later in that the “imp” module is gone, so I need to find a workaround for that, too.

Author: Kinsey Moore

2026-02-20T15:15:58.355Z

mentioned in merge request !221

Author: Kinsey Moore

2026-02-21T18:28:55.209Z

set status to Done

Author: Chris Johns

2026-08-08T05:26:45.742Z

set status to In progress

Author: Chris Johns

2026-08-08T05:26:51.033Z

assigned to @chris

Author: Chris Johns

2026-08-08T05:27:52.253Z

The theme is broken with Sphinx 9.1 and Python 3.14. The error is:

File "/opt/work/chris/rtems/rpy3.14/lib/python3.14/site-packages/sphinx/builders/html/__init__.py", line 1238, in handle_page
raise ThemeError(msg) from exc
sphinx.errors.ThemeError: An error happened in rendering the page index.
Reason: TypeError("argument of type '_CascadingStyleSheet' is not a container or iterable")

Author: Chris Johns

2026-08-13T23:34:19.960Z

mentioned in commit a509de7b6e36dcc114196faeedfb511f93b5279c

154 - Build warnings on 5 branch with Python 3.14 (opened)

Id

154

State

opened

Type

ISSUE

Author

Chris Johns

Assignee(s)

Chris Johns

Created

2026-08-08T04:35:00.672Z

Updated

2026-08-08T04:36:06.568Z

Milestone

5.4

Labels

doc

Link

https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/154

Merges

0

Summary

Running waf with Python 3.14 has these warnings:

./waf configure --prefix=/opt/src/rtems/docs/test
/opt/work/chris/rtems/docs/rtems-docs.git/common/waf.py:104: SyntaxWarning: "\\D" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\\\D"? A raw string is also an option.
ver = tuple(map(int, re.split('[\\D]', version)))
/opt/work/chris/rtems/docs/rtems-docs.git/common/waf.py:111: SyntaxWarning: "\\D" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\\\D"? A raw string is also an option.
ver = tuple(map(int, re.split('[\\D]', version)))
/opt/work/chris/rtems/docs/rtems-docs.git/common/latex.py:9: SyntaxWarning: "\\d" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\\\d"? A raw string is also an option.
'\\documentclass[a4paper,11pt,english]{report}']

Author: Chris Johns

2026-08-08T04:35:00.787Z

set status to In progress

Author: Chris Johns

2026-08-08T04:35:00.880Z

assigned to @chris

Author: Chris Johns

2026-08-08T04:36:11.784Z

added rtems#14 as parent item

Author: Chris Johns

2026-08-13T23:34:19.937Z

mentioned in commit 73f3f953df40228b287796468c03094a55b7a42d

155 - Update waf on 5 branch (opened)

Id

155

State

opened

Type

ISSUE

Author

Chris Johns

Assignee(s)

Chris Johns

Created

2026-08-08T04:35:56.512Z

Updated

2026-08-08T04:35:56.512Z

Milestone

5.4

Labels

doc

Link

https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/155

Merges

0

Summary

We should use the latest version.

Author: Chris Johns

2026-08-08T04:35:56.723Z

added rtems#14 as parent item

Author: Chris Johns

2026-08-08T04:35:56.817Z

set status to In progress

Author: Chris Johns

2026-08-08T04:35:56.940Z

assigned to @chris

Author: Chris Johns

2026-08-13T23:34:19.732Z

mentioned in commit a5769a0fbab767d8eb8242a5685cb7e09eda0395

152 - Docs version.py on 5 needs updating (opened)

Id

152

State

opened

Type

ISSUE

Author

Chris Johns

Created

2026-08-05T00:22:34.139Z

Updated

2026-08-05T02:01:34.159Z

Milestone

5.4

Labels

doc

Link

https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/152

Merges

0

Summary

Building a release set of docs on 5 raises this error:

Traceback (most recent call last):
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Scripting.py", line 119, in waf_entry_point
run_commands()
~~~~~~~~~~~~^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Scripting.py", line 182, in run_commands
ctx=run_command(cmd_name)
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Scripting.py", line 173, in run_command
ctx.execute()
~~~~~~~~~~~^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Scripting.py", line 375, in execute
return execute_method(self)
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Build.py", line 93, in execute
self.execute_build()
~~~~~~~~~~~~~~~~~~^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Build.py", line 96, in execute_build
self.recurse([self.run_dir])
~~~~~~~~~~~~^^^^^^^^^^^^^^^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Context.py", line 133, in recurse
user_function(self)
~~~~~~~~~~~~~^^^^^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/wscript", line 85, in build
ver_version, ver_date, ver_released = version.get(ctx, rtems_major_version)
~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/common/version.py", line 135, in get
v = configparser.SafeConfigParser()
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: module 'configparser' has no attribute 'SafeConfigParser'. Did you mean: 'RawConfigParser'?

I guess pulling version.py from main would help if that version is also OK?

Author: Chris Johns

2026-08-05T00:22:34.256Z

set status to To do

Author: Chris Johns

2026-08-05T02:01:34.124Z

added rtems#14 as parent item

Author: Chris Johns

2026-08-09T22:38:32.021Z

mentioned in merge request !251

Author: Chris Johns

2026-08-13T23:34:19.804Z

mentioned in commit 69f71ba66f569b5fd14e462771e93a4a6d9ca80d

Merge Requests

251 - Build fixes for a release RTEMS 5 branch documentation.

Id

251

State

merged

Merged by

Chris Johns

Merged at

2026-08-13T23:34:17.069Z

Assignee(s)

Chris Johns

Created

2026-08-08T05:35:48.947Z

Updated

2026-08-13T23:34:17.062Z

Milestone

5.4

Labels

doc, doc::sphinx

Link

https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/251

Commit

a509de7b6e36dcc114196faeedfb511f93b5279c

Summary

Fixes to building the docs on the 5 branch with Sphinx 9.1 and Python 3.14.

Generative AI

Used Claude to look at the error and then provide the 2 layout.html files we have. The fix is based on the its suggestions.

Author: Chris Johns

2026-08-08T05:35:49.139Z

assigned to @chris

Author: Chris Johns

2026-08-08T05:37:00.386Z

enabled an automatic merge when all merge checks for a509de7b6e36dcc114196faeedfb511f93b5279c pass

Author: Amar Takhar

2026-08-13T22:52:45.120Z

How come the switch to ``ConfigParser()``

Author: Chris Johns

2026-08-13T22:52:45.120Z

Author: Amar Takhar

2026-08-13T22:52:43.855Z

This isn’t your copyright EB should make this change

Author: Chris Johns

2026-08-13T22:52:43.855Z

It is a back port from main as I thought it may have the fix. It turns out it does not so the config parse change will need to be applied to main.

Author: Amar Takhar

2026-08-13T23:34:13.150Z

I’m not sure I understand this change, it should still be under build/?

Author: Chris Johns

2026-08-13T23:34:13.150Z

The build directory is only present in a build and when installed that CSS is installed into each document’s directory. My prefix is /opt/src/rtems/docs/test so I have:

$ find /opt/src/rtems/docs/test -name my-styles.css
/opt/src/rtems/docs/test/posix-users/_static/my-styles.css
/opt/src/rtems/docs/test/posix-compliance/_static/my-styles.css
/opt/src/rtems/docs/test/shell/_static/my-styles.css
/opt/src/rtems/docs/test/eclipse/_static/my-styles.css
/opt/src/rtems/docs/test/bsp-howto/_static/my-styles.css
/opt/src/rtems/docs/test/user/_static/my-styles.css
/opt/src/rtems/docs/test/develenv/_static/my-styles.css
/opt/src/rtems/docs/test/cpu-supplement/_static/my-styles.css
/opt/src/rtems/docs/test/c-user/_static/my-styles.css
/opt/src/rtems/docs/test/eng/_static/my-styles.css
/opt/src/rtems/docs/test/filesystem/_static/my-styles.css
/opt/src/rtems/docs/test/networking/_static/my-styles.css

and inspecting <head> for the user manual gives:

!`image.png <https://gitlab.rtems.org/-/project/uploads/f4a8bd4b0789daf146cc24fd1b283313/image.png>`_{width=”889” height=”351”}

Author: Kinsey Moore

2026-08-13T23:33:42.770Z

approved this merge request

Author: Amar Takhar

2026-08-13T23:34:13.178Z

resolved all threads

221 - Update docs build for modern systems

Id

221

State

merged

Merged by

Chris Johns

Merged at

2026-02-20T20:04:28.500Z

Assignee(s)

Kinsey Moore

Reviewer(s)

Chris Johns

Created

2026-02-20T15:15:52.813Z

Updated

2026-02-20T20:04:30.175Z

Milestone

5.4

Labels

doc::sphinx

Link

https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/221

Commit

081a3018dd1638de978c80a0b6680eeefa563d78

Summary

common/…theme_rtems/layout.html: Update theme for modern Sphinx

Old themes tend to use “style” and this is now a reserved keyword. Use styles[-1], instead.

Updates #135

common/waf.py: Backport importlib compatibility

This backports usage of importlib from main with the ability to continue functioning on python 2.x with the ‘imp’ module.

Closes #135

Generative AI

Author: Kinsey Moore

2026-02-20T15:15:52.949Z

requested review from @chris

Author: Kinsey Moore

2026-02-20T15:15:52.970Z

assigned to @opticron

Author: Chris Johns

2026-02-20T20:04:24.737Z

approved this merge request