breathe icon indicating copy to clipboard operation
breathe copied to clipboard

Issue with: retrieve_project_info_for_auto for doxygen

Open alexandraBara opened this issue 2 years ago • 3 comments

I have not found a solution for this, so hoping to get some enlightenment on this issue.

conf.py:

project = 'tuna'
release = '0.1.0'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = ['sphinx.ext.autodoc', 'breathe']
breathe_projects = { "tuna": "../tuna" }

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'breathe/*']



# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']

index.rst file:

Welcome to MITuna's documentation!
==================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   readme
   doxygen_files
   
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

and doxygen_files.rst:

Doxygen Files
=============
.. autodoxygenindex::
   :project: tuna

Now, this is my error:

Removing everything under '_build'...
Running Sphinx v5.1.1
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 3 source files that are out of date
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [ 33%] doxygen_files                                                                                                             
Exception occurred:
  File "/home/alex/myvenv/lib/python3.6/site-packages/breathe/project.py", line 202, in retrieve_project_info_for_auto
    return self.project_info_for_auto_store[name]
KeyError: 'tuna'
The full traceback has been saved in /tmp/sphinx-err-onfjly7r.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Makefile:20: recipe for target 'html' failed

alexandraBara avatar Aug 18 '22 20:08 alexandraBara

I also tried adding this line to conf.py:

breathe_projects_source = { "tuna": "xml/" }

and this generates a new error:

Removing everything under '_build'...
Running Sphinx v5.1.1
making output directory... done

Extension error (breathe.directives.setup):
Handler <function setup.<locals>.doxygen_hook at 0x7fe73a6ebd08> for event 'builder-inited' threw an exception (exception: too many values to unpack (expected 2))
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 2

alexandraBara avatar Aug 18 '22 20:08 alexandraBara

I just had the same issues. It only errors for auto* directives; plain doxygenfile etc work fine for me.

  • Breathe 4.34.0
  • Sphinx 5.3.0
  • Doxygen 1.9.5
  • Python 3.10.9 on an ARM Mac

unawarez avatar Dec 23 '22 23:12 unawarez

I had the same issues using auto directives too.

  • Breathe 4.35.0
  • Sphinx 4.5.0
  • Doxygen 1.8.17
  • Python 3.9.10 on windows

I also tried adding this line to conf.py:

breathe_projects_source = { "tuna": "xml/" }

and this generates a new error:

Removing everything under '_build'...
Running Sphinx v5.1.1
making output directory... done

Extension error (breathe.directives.setup):
Handler <function setup.<locals>.doxygen_hook at 0x7fe73a6ebd08> for event 'builder-inited' threw an exception (exception: too many values to unpack (expected 2))
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 2

lSabrinel avatar Oct 03 '23 15:10 lSabrinel