Use our modern JSON doc writer, and fix errors in docs.
Review Request #14803 — Created Feb. 8, 2026 and submitted
We weren't using our improved JSON writer for the RBTools documentation
and release notes, which meant we weren't getting the Table of Contents
and other metadata embedded in the output. This forced the building to
take place server-side, utilizing legacy code that isn't compatible with
modern versions of Sphinx. We now make use of the improved JSON writer
to fix this.We also had a couple of regressions in our docs.
The new code for showing deprecated/renamed options introduced a syntax
error in the generated ReST, with the document body not being indented
within the directive. This has been fixed.On newer Pythons, autodoc would look for an
__annotate_func__, which
led to all kinds of errors. We now include this in the exclude list.
Built the docs. Saw that these errors went away.
Consumed the new docs in the website codebase, and it properly showed
the Table of Contents based on the modern metadata.
| Summary | ID |
|---|---|
| 625daaf50460f8b0fd99ac4d24be838b47e46e46 |