Comments (3)
This has been implemented and is probably best used with the following aliases:
ALIASES = "rst=\xmlonly<rst>"
ALIASES += "endrst=</rst>\endxmlonly"
Which allows you to do code like:
/*!
Inserting additional restructured text information.
\rst
.. note::
This restructured text has been handled correctly.
\endrst
*/
Hopefully will be enough.
from breathe.
This has been changed to use the \verbatim blocks in doxygen as the \xmlonly blocks required you to xml-escape the text you were entering. Not cool!
ALIASES = "rst=\verbatim embed:rst"
ALIASES += "endrst=\endverbatim"
Still needs to be documented, but those are the aliases that will now do the business. The old approach is no longer supported as it was only 2 days old itself.
from breathe.
Closing as this has been implemented.
from breathe.
Related Issues (20)
- no-link option not working
- Sphinx 7.2 support HOT 2
- AttributeError: 'PosixPath' object has no attribute 'rstrip' in breathe/project.py HOT 4
- Drop EOL python 3.7?
- Missing `python` version for dependency management
- Wrong required python version 3.6+
- GH Actions: broken unit test
- Issue with dispaly of notes in sphinx documentation HOT 1
- Support Sphinx ToC generation with `_toc_name` and `_toc_parts` attribute
- Provide some diagnostic warnings if references to functions are missing parentheses HOT 1
- En-dash in @return renders incorrectly
- Duplicate declaration/description warnings HOT 1
- Add make.bat for building breathe's documentation on Windows HOT 1
- Duplicate C++ declaration with nested anonymous structure
- `RemovedInSphinx80Warning` in `ProjectInfoFactory.__init__`
- Test suite does not pass against Sphinx 7.2.6
- Automatic way to generate `.rst` files from doxygen xml HOT 1
- `Doxygenclass` is empty
- Breathe breaks with sphinx 7.3.X HOT 3
- Referencing a ```doxygengroup```
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 breathe.