Giter Club home page Giter Club logo

Comments (5)

svenevs avatar svenevs commented on July 16, 2024 1

Well, that's certainly unexpected! Hmmmm. I will have to look into this page business, thanks for creating a repro example! I don't know how easy this one will be to fix, in the meantime I wonder if you can get away with just using the sphinx todo directive?

  • in conf.py's extensions list add "sphinx.ext.todo" (same list where "breathe" and "exhale" are

  • in docs, you have to do that in an \rst block:

    /**
     * \rst
     * .. todo:: implement me!
     * \endrst
     */
    
  • somewhere in your docs, e.g. docs/todo.rst include the .. todolist:: directive to dump them all out

Doesn't fix the actual problem here, but I think it could be a usable workaround?

from exhale.

5p4k avatar 5p4k commented on July 16, 2024

Thanks! The todo list is more of "nice to have" for my project, but it definitely can be useful to others too.
The workaround works perfectly, but I had to

  • add todo_include_todos = True to conf.py

Now that's what I'm getting:

image

from exhale.

schmoelder avatar schmoelder commented on July 16, 2024

Hey, is there any update on this issue?

from exhale.

svenevs avatar svenevs commented on July 16, 2024

as far as i know this can be closed, doxygen page support was added in #114 so i think it will work with regular old \todo in doxygen as well as the rst solution and .. todolist:: is another viable contendor

please speak up if it's not fully solved

from exhale.

brub43 avatar brub43 commented on July 16, 2024

this also seems to happen with the @deprecated doxygen command.

from exhale.

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.