Code Monkey home page Code Monkey logo

Comments (4)

michaeljones avatar michaeljones commented on June 12, 2024

Thanks for the extra information. It seems that the "sections" are rendered as definition lists and so each member (function in this case) is rendered as a list item. Works fine when you render a class and so come down through the sections to the members, but not when you use doxygenfunction and skip straight to the member.

I'll take a quick look, either we can add a definition list declaration to the doxygenfunction directive to wrap the function that is coming back, or maybe try to move the item declaration in the section as well. Not sure, will look.

Cheers,
Michael

from breathe.

michaeljones avatar michaeljones commented on June 12, 2024

Hi Ryan,

I've just pushed something that should help a little. Turns out a few other more targetted directives were failing for the same reason.

One issue left though, is that the testsuite still doesn't output a pdf properly unless you delete all the references to the "nutshell" example. The issue is that there seems to be too much hierarchy in that example which results in breathe generating more than the 6 nested lists that are allowed in latex. So depending on your code you might still have some issues.

Not sure how to address it myself, not very experienced with latex. Might requires some more work.

Hope it helps, let me know if you experience some more issues,
Michael

from breathe.

RyanMallon avatar RyanMallon commented on June 12, 2024

On 05/07/11 11:30, michaeljones wrote:

Hi Ryan,

I've just pushed something that should help a little. Turns out a few other more targetted directives were failing for the same reason.

One issue left though, is that the testsuite still doesn't output a pdf properly unless you delete all the references to the "nutshell" example. The issue is that there seems to be too much hierarchy in that example which results in breathe generating more than the 6 nested lists that are allowed in latex. So depending on your code you might still have some issues.

Not sure how to address it myself, not very experienced with latex. Might requires some more work.

Hope it helps, let me know if you experience some more issues,
Michael
Hi Michael,

Thanks, that fixed the test project I have. One difference in the pdf
and html output is that I only get the top-level entry in the pdf
contents, whereas the html has the subsections listed in the table of
contents. I think this is probably related to how I have my rst files
organised though since the toctree only has one entry.

Thanks,
~Ryan

from breathe.

michaeljones avatar michaeljones commented on June 12, 2024

Hey,

Glad it helped.

I'm happy to be proved wrong, but I imagine the differences you're seeing are more to do with how Sphinx is handling the output from Breathe (which is the same in both cases) rather than anything Breathe is doing.

Let me know if you find anything more though,
Cheers,
Michael

from breathe.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.