CADET-Core icon indicating copy to clipboard operation
CADET-Core copied to clipboard

Include Doxygen build

Open schmoelder opened this issue 3 years ago • 9 comments

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'

schmoelder avatar Jun 21 '21 14:06 schmoelder

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!

schmoelder avatar Jun 18 '24 12:06 schmoelder

please try again.

schmoelder avatar Jun 18 '24 13:06 schmoelder

Did you use the updated command?

sphinx-multiversion ./ ./build/ -D 'exhale_args.containmentFolder=${sourcedir}/api'

schmoelder avatar Jun 19 '24 09:06 schmoelder

yes

jbreue16 avatar Jun 19 '24 09:06 jbreue16

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?

schmoelder avatar Jun 19 '24 16:06 schmoelder

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):

ronald-jaepel avatar Jun 20 '24 09:06 ronald-jaepel

For Windows cmd the command needs to be without single quotes, so sphinx-multiversion ./ ./build/ -D exhale_args.containmentFolder=${sourcedir}/api works.

ronald-jaepel avatar Jun 20 '24 09:06 ronald-jaepel

Thanks! Unfortunately, it doesn't run on Linux without the quotes so I added a comment in the README.

schmoelder avatar Jun 20 '24 09:06 schmoelder

Sorry to ask, but what are the next steps?

schmoelder avatar Aug 20 '24 13:08 schmoelder