Documentation theme update

Christian MAUDERER christian.mauderer at embedded-brains.de
Wed Feb 21 08:22:49 UTC 2024


Hello Chris,

On 2024-02-21 06:16, Chris Johns wrote:
> Hi,
> 
> I have a patch for rtems-docs.git to move us to the pip installed
> sphinx-rtd-theme removing the custom theme based on sphinx-rtd-theme we
> currently use.
> 

I think reducing RTEMS specific adaptions is a great idea. So thank you 
for that.

> The ticket is #4994.
> 
> The patch is over 4M in size as it deletes common/sphinx_rtd_theme_rtems. YOu
> can download it from:
> 
>   https://ftp.rtems.org/pub/rtems/people/chrisj/0001-sphinx-Use-the-pip-installed-sphinx-rtd-theme.patch
> 
> What I am not sure about is how old Sphinx can be to build the documentation. My
> versions are:
> 
>   Sphinx                        7.2.6
>   sphinx-rtd-theme              2.0.0
>   sphinxcontrib-applehelp       1.0.7
>   sphinxcontrib-bibtex          2.6.1
>   sphinxcontrib-devhelp         1.0.5
>   sphinxcontrib-htmlhelp        2.0.4
>   sphinxcontrib-jquery          4.1
>   sphinxcontrib-jsmath          1.0.1
>   sphinxcontrib-qthelp          1.0.6
>   sphinxcontrib-serializinghtml 1.1.9
> 
> Is it OK to push?

I tried building the manuals with your patches on OpenSUSE. It's 
basically the same procedure as without the patch except that the 
sphinx-rtd-theme is now necessary. The result looks as expected.

With the patch, the search seems to work again. That hasn't been the 
case with the old version.

So from my point of view, the patch is a great improvement and OK.

Best regards

Christian


More information about the devel mailing list