[PATCH rtems-docs 0/2] Sphinx Version Check

Joel Sherrill joel at rtems.org
Tue Jul 25 20:25:44 UTC 2023


Hi

There has been Discord and email discussion that upgrading to Sphinx >=
6.0 breaks unordered bullet lists. But using Sphinx < 6.0 does not
produce correct results with the patch which enabled us to use newer
versions of Sphinx. There are two patches in this series.

(1) Reverts the patch which broke document generation. Hopefully this
can be reapplied once someone with time and more Sphinx knowledge than I
have figures out what is actually broken.

(2) Enhances the Sphinx version check to be able to check for a version
greater than a minimum (current behavior) or if the Sphinx version is
within an acceptable range. The acceptable min/max versions are set at
the top of the file.

I think these are simple patches to unwedge documentation generation
until a solution allowing us to upgrade is figured out. Then the minimum
can be changed to 6.0 and maximum to None.

OK to commit?

--joel

Joel Sherrill (2):
  layout.html: Revert patch forcing Spinx to >= 6.0
  common/waf.py: Add option to check maximum Sphinx version

 common/sphinx_rtd_theme_rtems/layout.html |  2 --
 common/waf.py                             | 17 ++++++++++++++---
 2 files changed, 14 insertions(+), 5 deletions(-)

-- 
2.31.1



More information about the devel mailing list