<html>#2551: include RePriMand in the ET
<table style='border-spacing: 1ex 0pt; '>
<tr><td style='text-align:right'> Reporter:</td><td>Roland Haas</td></tr>
<tr><td style='text-align:right'> Status:</td><td>open</td></tr>
<tr><td style='text-align:right'>Milestone:</td><td>ET_2021_11</td></tr>
<tr><td style='text-align:right'> Version:</td><td>development version</td></tr>
<tr><td style='text-align:right'> Type:</td><td>enhancement</td></tr>
<tr><td style='text-align:right'> Priority:</td><td>major</td></tr>
<tr><td style='text-align:right'>Component:</td><td></td></tr>
</table>
<p>Comment (by Roland Haas):</p>
<p>Ideally there would be a TeX file documetnation.tex that can be used in the usual ET manner. Ie:</p>
<ul>
<li>is included in the online doumentation auto-generated from the documentation.tex files</li>
<li>can be use to create a local thornguide / thorndoc using the respective make targets</li>
<li>can be used with <code>cd FOO/doc; pdflatex documentation.tex</code> to create documentation.pdf. The goal here is uniformity of available documentation to avoid situations where some thorns might have “<a data-is-external-link="true" href="http://README.md" rel="nofollow">README.md</a>”, others “index.html”, and more again “Start.docx”.</li>
</ul>
<p>Said tex file should ideally be using the sphinx generated tex files, but some thorns instead just point to the actual documentation (eg. <a data-is-external-link="true" href="https://www.einsteintoolkit.org/thornguide/WVUThorns/Baikal/documentation.html" rel="nofollow">https://www.einsteintoolkit.org/thornguide/WVUThorns/Baikal/documentation.html</a>). This approach, of course, is a poor substitute for the real thing.</p>
<p>Really good documetnation is eg in <a data-is-external-link="true" href="https://www.einsteintoolkit.org/thornguide/CactusNumerical/MoL/documentation.html" rel="nofollow">https://www.einsteintoolkit.org/thornguide/CactusNumerical/MoL/documentation.html</a> and there’s of course also empty documentation eg <a data-is-external-link="true" href="https://www.einsteintoolkit.org/thornguide/CactusUtils/Vectors/documentation.html" rel="nofollow">https://www.einsteintoolkit.org/thornguide/CactusUtils/Vectors/documentation.html</a> which should be avoided.</p>
<p>--<br/>
Ticket URL: <a href='https://bitbucket.org/einsteintoolkit/tickets/issues/2551/include-reprimand-in-the-et'>https://bitbucket.org/einsteintoolkit/tickets/issues/2551/include-reprimand-in-the-et</a></p>
</html>