I'd like to make you aware of a set of patches that are currently in review under the "pb/sphinx-doc" topic. These patches do some preparatory work on our documentation so that the reStructured Text (RST) documents can be rendered using a tool called Sphinx (http://www.sphinx-doc.org). This tool will allow us, going forward, to investigate additional output formats and publishing options for the documentation.
The aim of these specific patches is to:
1) Prepare the documentation for building with the Sphinx application
2) Improve the general formatting and naming of the documents
3) Organise the documents into a sensible structure
4) Maintain compatibility with existing renderers
You can find the first patch in the chain on our Gerrit review system, here: https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/1041 . Follow the "Relation Chain" to see all of the related patches in the series.
Please note that documentation for upstream platforms is modified by these patches as part of the reformatting. These changes should all be minor but platform maintainers may wish to give them a quick review, especially this one: https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/1046 .
As always, any feedback on these changes is welcome and there will always be the opportunity to make further changes beyond the scope of these patches.
Best Regards, Paul