Recent posts to How to use a Sphinx extension (PlantUML) for library documentationhttps://forge.codesys.com/forge/talk/Engineering/thread/1bd6a04e69/2020-06-24T12:36:48.631000ZRecent posts to How to use a Sphinx extension (PlantUML) for library documentationHow to use a Sphinx extension (PlantUML) for library documentation2020-06-24T12:36:48.631000Z2020-06-24T12:36:48.631000Zhhuebnerhttps://forge.codesys.com/u/hhuebner/https://forge.codesys.comb5e96d57ef6f32f6c9e2b569ed104cdc40dcfc47<div class="markdown_content"><p>Hello everyone<br/>
I would like to use PlantUML diagrams as an additional element for the library documentation.<br/>
<a href="https://plantuml.com" rel="nofollow">https://plantuml.com</a></p>
<p>There is a Sphinx extension for this. <br/>
<a href="https://pypi.org/project/sphinxcontrib-plantuml/" rel="nofollow">https://pypi.org/project/sphinxcontrib-plantuml/</a></p>
<p>I have tried the following:</p>
<ul>
<li>A directory "sphinxcontrib" was created in the directory "<Codesys installation directory>\CODESYS\DocScripting\3.5.11.0\contrib".</li>
<li>The file "plantuml.py" was copied to "<Codesys installation directory>\CODESYS\DocScripting\3.5.11.0\contrib\sphinxcontrib".</li>
<li>The file "plantuml.jar" has been copied to "c:\plantuml\plantuml.jar".</li>
<li>
<p>The file "<Codesys installation directory>\CODESYS\DocScripting\3.5.11.0\templates\conf.py" has been modified as follows:</p>
<ul>
<li>The section "extensions" has been extended by "'sphinxcontrib.plantuml',"</li>
<li>The section "plantuml" was added with the value "'java -jar c:\plantuml\plantuml.jar'"</li>
</ul>
<p>The sections of the configuration:</p>
</li>
</ul>
<div class="codehilite"><pre><span></span> <span class="n">extensions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'sphinx.ext.todo'</span><span class="p">,</span>
<span class="s1">'sphinx.ext.codesys'</span><span class="p">,</span>
<span class="s1">'sphinx.ext.mathjax'</span><span class="p">,</span>
<span class="s1">'sphinxcontrib.plantuml'</span><span class="p">,</span>
<span class="o">#</span> <span class="s1">'sphinx.ext.intersphinx'</span><span class="p">,</span>
<span class="o">#</span> <span class="s1">'sphinx.ext.extlinks'</span><span class="p">,</span>
<span class="p">]</span>
<span class="n">todo_include_todos</span> <span class="o">=</span> <span class="k">False</span>
<span class="n">plantuml</span> <span class="o">=</span> <span class="s1">'java -jar c:\plantuml\plantuml.jar'</span>
</pre></div>
<p>Unfortunately it is still not possible to use the ".. uml::" directive. The error "Unknown directive type uml" is always reported.</p>
<p>Am I doing something wrong or is it impossible to use Sphinx extensions with Codesys?</p>
<p>Many Thanks!</p></div>