Comments (5)
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
'sextensions
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.
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
toconf.py
Now that's what I'm getting:
from exhale.
Hey, is there any update on this issue?
from exhale.
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.
this also seems to happen with the @deprecated
doxygen command.
from exhale.
Related Issues (20)
- ignore file extensions in directory? HOT 6
- "createTreeView":True with RTD theme does not show Class Hierarchy HOT 1
- Operator>>, <<, -> overloading bug HOT 4
- Unable to resolve function HOT 1
- Warnings caused by missing newlines in exhale output HOT 3
- LaTeX in \f$ swallows \n newlines HOT 2
- Allow root file to be excluded and set filename of hierarchy files HOT 1
- Replace collapsible list JavaScript with details/summary HOT 1
- Does it work for C projects? HOT 1
- Module Index Error 404 page HOT 1
- Exhale seems to eat asterisk-chars '*' HOT 1
- Exhale does not find functions with weird data types
- Hard-coded 'Class' and 'Classes' even for C
- Allow fully qualified enum, class, structs titles
- Fixup packaging requirements HOT 8
- Windows path length issues HOT 4
- no coverage uploaded for master HOT 1
- KeyError: 'concept' when listing nodes to console HOT 1
- Problem with Sphinx 7
- Github action fails HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from exhale.