Comment (by Roland Haas):

Ideally there would be a TeX file documetnation.tex that can be used in the usual ET manner. Ie:

• is included in the online doumentation auto-generated from the documentation.tex files
• can be use to create a local thornguide / thorndoc using the respective make targets
• can be used with cd FOO/doc; pdflatex documentation.tex to create documentation.pdf. The goal here is uniformity of available documentation to avoid situations where some thorns might have “README.md”, others “index.html”, and more again “Start.docx”.

Said tex file should ideally be using the sphinx generated tex files, but some thorns instead just point to the actual documentation (eg. https://www.einsteintoolkit.org/thornguide/WVUThorns/Baikal/documentation.html). This approach, of course, is a poor substitute for the real thing.

Really good documetnation is eg in https://www.einsteintoolkit.org/thornguide/CactusNumerical/MoL/documentation.html and there’s of course also empty documentation eg https://www.einsteintoolkit.org/thornguide/CactusUtils/Vectors/documentation.html which should be avoided.

--
Ticket URL: https://bitbucket.org/einsteintoolkit/tickets/issues/2551/include-reprimand-in-the-et