Problem with autogenerated Doxygen documentation with exhale/breathe/sphinx fro

114 views
Skip to first unread message

Forest Rouse

unread,
May 31, 2023, 4:21:39 PM5/31/23
to sphinx-users
Hi.  Am trying to autogenerate C++ documentation using doxygen in conjunction with exhale and breathe.  Mostly everything is working okay.  However, sphinx cannot find the autogenerated index file.

Building documentation is part of our automation process so procedurally, we clean the build directories (in our case _build, and _api) prior to making the html.

I have exhale configured with containmentFolder _api and rootFileName as cpp.

I have a top-level index file pointing to _api/cpp.  But even though cpp.rst is emitted, I get the following error message

> /home/ir/iridium/eng_docs/doxygen.rst:10: WARNING: toctree contains reference to nonexisting document '_api/cpp'

The file exists.   If we don't clean the _api directory, we don't get this error though officially we are using the cpp.rst generated from the previous run.

I've looked though references online and cannot find a solution to the problem.  Anyone have any ideas?

Forest

Forest Rouse

unread,
May 31, 2023, 4:52:34 PM5/31/23
to sphinx-users
Figured out the problem.  I thought I should put the _api directory on the exclude_patterns list.  That was a mistake.  Once I removed it from the list, sphinx was able to find the cpp.rst file.
Reply all
Reply to author
Forward
0 new messages