sphinx-needs icon indicating copy to clipboard operation
sphinx-needs copied to clipboard

:needs: role in doxygen-breathe rst section leads to sphinx-needs crash

Open arwedus opened this issue 4 years ago • 2 comments

While sphinx-needs directives inside a \verbatim embed:rst section are parsed by sphinx-needs (after being imported by breathe if they are included by one of the sphinx-breathe directives), the :needs: role leads to a hard error in sphinx-needs.

I tried to use a standard sphinx role (:doc:) and a configurable role of another sphinx extension (sphinx.ext.extlink) and both work just fine.

To reproduce the error I have attached an example project.

  /**
   * NOTE: The rstinline section below leads to a hard error in sphinx-needs
   * 
   * The \rstinline{:doc:`index`} realizes \rstinline{:need:`REQ_CAT_0001` and :need:`REQ_CAT_0002`}
   * and implements \rstinline{:issue:`26`}
   */
  void meow();

arwedus avatar Nov 28 '21 13:11 arwedus

@arwedus This is a known issue and needs fix within breathe. See https://github.com/useblocks/sphinxcontrib-needs/issues/231

twodrops avatar Nov 28 '21 18:11 twodrops

indeed, indeed. Importing the same C++ class comment via a doxygennamespace directive works just fine. Thanks for the hint @twodrops

arwedus avatar Nov 28 '21 20:11 arwedus