exhale icon indicating copy to clipboard operation
exhale copied to clipboard

containmentFolder must be direct subfolder of srcdir

Open apartridge opened this issue 6 years ago • 1 comments

Using this containmentFolder

"containmentFolder": "./apireference/cpp",

fails with the following error:

The given containmentFolder [/home/stian/stian_sphinx_testing/apireference/cpp] must be a SUBDIRECTORY of [/home/stian/stian_sphinx_testing].

Debugging the code, I see the following values for _one, _two and _three in configs.py:

_one=False _two=False _three=True

Exhale version 0.2.3

apartridge avatar Oct 16 '19 09:10 apartridge

Hi @apartridge,

Yes this is currently a documented requirement. However,

The verbiage subdirectory means direct subdirectory. So the path "./library/api" will be rejected. This is because I make the assumption that containmentFolder is “owned” by Exhale / is safe to delete.

I don't think it's really necessary to enforce direct subdirectory. As long as Exhale gets to own containmentFolder directly, it just needs to be any subdirectory. I'll relax the constraint.

svenevs avatar Oct 20 '19 03:10 svenevs