Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C domain generation doesn't work with Breathe v4.12+ #483

Closed
rdeterre opened this issue Mar 9, 2020 · 3 comments · Fixed by #512
Closed

C domain generation doesn't work with Breathe v4.12+ #483

rdeterre opened this issue Mar 9, 2020 · 3 comments · Fixed by #512
Assignees
Labels
bug Problem in existing code code Source code regression Something broke that worked in the past

Comments

@rdeterre
Copy link

rdeterre commented Mar 9, 2020

Hi,

When using the breathe_domain_by_extension variable in conf.py to set the domain of some files to be C, the documentation generated for enums is invalid. This is only true for Breathe versions v4.12 and up, v4.11 works OK.

The gist of it is that the enum definition below generates the output from the image copied below, where the enumerand names are missing.

/// A dummy enum
enum color {
    red   = 0xFF0000,
    green = 0x00FF00,
    blue  = 0x0000FF,
};

image

Here is a link to a minimal example that reproduces this issue: https://github.com/rdeterre/breatherepro

My setup for testing was the following:

  • Windows machine
  • Python 3.8.1
  • Sphinx 2.4.1

I tried all releases of Breathe since v4.11.

@vermeeren
Copy link
Collaborator

Possibly related to 4557198 and/or df5b389.

If you have some time to help could you check the diffs and locally test with modifications in these parts to see what fixes it?

@vermeeren vermeeren added bug Problem in existing code code Source code regression Something broke that worked in the past labels Mar 18, 2020
@vermeeren
Copy link
Collaborator

Might be automatically fixed with Sphinx 3 and latest Breathe, considering the C domain was rewritten and Breathe now uses Sphinx in a more proper way compared to before.

If you could verify that it would be great.

vermeeren added a commit that referenced this issue May 1, 2020
@vermeeren vermeeren self-assigned this May 1, 2020
@vermeeren
Copy link
Collaborator

Should be fixed with #512, released in Breathe v4.17.0. Note that you also need Sphinx 3.x for recent Breathe versions.

@vermeeren vermeeren linked a pull request Dec 3, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Problem in existing code code Source code regression Something broke that worked in the past
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants