Closed mvorisek closed 1 year ago
Currently it seems all wrong input is silently accepted and all internal parse errors supressed.
Example rst:
.. php:class:: Scope .. php:method:: simplify();
notice the ; at the method end. The ; should not be present, but when present, the rendered result is very off:
;
<dl class="php method"> -<dt class="sig sig-object php" id="Scope::simplify"> -<span class="sig-prename descclassname"><span class="pre">Scope::</span></span> -<span class="sig-name descname"><span class="pre">simplify</span></span> -<span class="sig-paren">(</span><span class="sig-paren">)</span> -<a class="headerlink" href="#Scope::simplify" title="Permalink to this definition">¶</a></dt> +<dt class="sig sig-object php"> +<span class="sig-name descname"><span class="pre">simplify();</span></span></dt> <dd></dd></dl>
catching such typos manually is very hard.
Sphinx does support build warnings, example:
So I expect this extension to emit warning on wrong input as well.
Zero warnings can be then then easily asserted using CI.
Currently it seems all wrong input is silently accepted and all internal parse errors supressed.
Example rst:
notice the
;
at the method end. The;
should not be present, but when present, the rendered result is very off:catching such typos manually is very hard.
Sphinx does support build warnings, example:
So I expect this extension to emit warning on wrong input as well.
Zero warnings can be then then easily asserted using CI.