Comments (6)
I was REALLY happy with how it came out
Thanks, glad to hear 🙂
I think I'm misunderstanding a bit, there's probably a configuration somewhere but which one (so many tools involved xD)?
If you wanted to exclude files from doxygen (and therefore prevent exhale from ever processing it), you would probably want to add to your doxygen configuration EXCLUDE
or EXCLUDE_PATTERNS
.
So either in the Doxyfile
or in exhaleDoxygenStdin
.
import textwrap
exhale_args = {
# ... required args ...
"exhaleExecutesDoxygen": True,
# just an example
"exhaleDoxygenStdin": textwrap.dedent('''
EXCLUDE_PATTERNS = *.cpp
''')
}
- Is the
readme.md
per directory a part of the documentation build? Or is just for navigating e.g., GitHub readme? Like are you talking about the "doxygen documentation for the directory" example? - Or are you asking how to have a separate project for say
include
andsrc
rather than them both being in the same sphinx output? (there is just one RTD site?)
from exhale.
Ahh, sorry, I mean that I just want to not have the readme.md
s parsed and rendered is all. Thanks for asking to clarify!
from exhale.
Ok then yeah you should be able to get doxygen to ignore them with EXCLUDE
or EXCLUDE_PATTERNS
, if you don't have success post your conf.py
(or relevant section).
But actually, if you don't have other markdown files that you want doxygen to process (e.g., for \page
or \group
[group not supported in exhale]) you can also override the default FILE_PATTERNS
. Doxygen has a lot of configs
from exhale.
Gotcha, thanks!
..... How do I pass in arguments to the doxygen build when I don't have a Doxyfile
? I tried searching for EXCLUDE_PATTERNS
on the exhale docs but I didn't seem to find an example. Would it be in a key value for exhale_args
?
The file in question is here
from exhale.
Brief comment from phone, sorry just left xD
https://github.com/openfheorg/openfhe-development/blob/exhale/docs/conf.py#L113
The configurations there with PREDEFINED are what go to doxygen, just add them in that string I think
If not I can take a closer look soon 🙂
from exhale.
That worked! Thank you so so much!
from exhale.
Related Issues (20)
- "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.