search

zephyrproject-rtos / zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
https://docs.zephyrproject.org
Apache License 2.0
10.82k stars 6.59k forks source link

Figure out new combo for breathe/doxygen/sphinx versions that are supported #3103

Closed zephyrbot closed 7 years ago

zephyrbot commented 7 years ago

Reported by Anas Nashif:

All components have new versions and there some issues when installing the wrong combo, so we need to re-verify the supported versions and document them

(Imported from Jira ZEP-1647)

zephyrbot commented 7 years ago

by David Kinder:

Anas Nashif In GH-2035 there's a comment saying you know what the right combo is. Can you let me know and I'll verify and update.

zephyrbot commented 7 years ago

by Anas Nashif:

David Kinder I got it working somehow, but then it did not work on some other machine, so the version compatibility is not clear. I do not have the magic bullet yet.

zephyrbot commented 7 years ago

by David Kinder:

OK. I'll figure it out then. Thanks.

zephyrbot commented 7 years ago

by David Kinder:

Almost have latest versions of tools building zephyr docs:

breathe 4.6.0 docutils 0.13.1 sphinx 1.6.2 doxygen 1.8.11

breath still has a showstopper, but there is a [PR that fixes the issue|https://github.com/michaeljones/breathe/pull/334/commits/2af44a0d9f40e672dd1989b67d0e90a61deba77e] (it hasn't been merged yet in a published version of breathe -- I manually patched it on my system and it ran to completion)

Alas, the same doxygen/breathe errors show up (e.g., "Invalid definition: Expected identifier is nested name... etc.) so there's no particular advantage moving to these newer versions from what we're currently using for the doc build.

zephyrbot commented 7 years ago

by David Kinder:

Python component versions that work (as best as they can), are documented in scripts/requirements.txt

 breathe==4.6.0
 sphinx==1.5.5
 docutils==0.13.1
 sphinx_rtd_theme