CADET-Core
CADET-Core copied to clipboard
Include Doxygen build
Fixes #88
I can locally build doxygen with doxygen doc/cadet.doxyfile
. However, sphinx currently produces an error due to an open issue upstream when using @todo in the documentation.
(!) Unabridged API: unexpected kind 'page' (IGNORED)
[...]
File "~/miniconda3/envs/sphinx/lib/python3.9/site-packages/exhale/graph.py", line 516, in toConsole
kind=utils._use_color(self.kind, fmt_spec[self.kind], sys.stderr),
KeyError: 'page'
This should work now. It's not pretty but that's more of a long term project, I'd say. Please verify that it builds locally!
please try again.
Did you use the updated command?
sphinx-multiversion ./ ./build/ -D 'exhale_args.containmentFolder=${sourcedir}/api'
yes
Hmm, it does work for me and I got the command from the sphinx-multiversion documentation. Maybe it's a Windows issue? @ronald-jaepel could you try to reproduce this?
sphinx-build -b html . build
works
sphinx-multiversion ./ ./build/ -D 'exhale_args.containmentFolder=${sourcedir}/api'
produces the same error that Jan got:
The given `containmentFolder` [C:\Users\ronal\Documents\CADET\doc\api] must be a *SUBDIRECTORY* of [C:\Users\ronal\AppData\Local\Temp\tmpq3qlnnkv\17599e50de92cdc95c89a2ce98c529c18cee471e\doc].
Traceback (most recent call last):
For Windows cmd the command needs to be without single quotes, so
sphinx-multiversion ./ ./build/ -D exhale_args.containmentFolder=${sourcedir}/api
works.
Thanks! Unfortunately, it doesn't run on Linux without the quotes so I added a comment in the README.
Sorry to ask, but what are the next steps?