Check if the hierarchy files exist before generating includes.

[clalancette]

This reverts commit 0d1a8a8.

With this in place, I was getting errors of the kind:

docs_build/rcl_lifecycle/rcl_lifecycle/default_sphinx_project/generated/index.rst:3: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'default_sphinx_project/generated/page_view_hierarchy.rst.include'.

That is, because final_data_string is empty, we were never creating page_view_hiearchy.rst.include, but we were still trying to .. include it. Revert this patch, which seems to make things happier. @roehling FYI. @svenevs What do you think?

[roehling]

This revert will break Debian packages which use exhale, because dh_installdocs refuses to install empty documentation files.

[clalancette]

This revert will break Debian packages which use exhale, because dh_installdocs refuses to install empty documentation files.

OK, thanks for the feedback. In that case, please check out d65df03

[svenevs]

Thanks for the patch, will take a look this weekend. If you can link a project that was affected that'd be really helpful 🙂

[clalancette]

Thanks for the patch, will take a look this weekend. If you can link a project that was affected that'd be really helpful slightly_smiling_face

The project that I saw this with is rosdoc2: https://github.com/ros-infrastructure/rosdoc2 . rosdoc2, however, is really a wrapper around doxygen/sphinx/breathe/exhale, so that may not be entirely helpful to you. If you'd like me to try to extract an exact sphinx configuration that rosdoc2 generated that caused this problem, I can do that; just let me know.

[svenevs]

Yeah that could be helpful, or link me to a known project using it so I can test on that as well. Thanks!

[svenevs]

Adding note to myself, where I got turned around

exhale/testing/base.py

Line 540 in d6fa84f

# Make sure every document expected to be .. include::'ed in the library root

Those tests are issued for every test class via test_common() which gets injected via base testing class. Need to get repro or fix that section of the testing code.

[svenevs]

Tested things with #148 (comment) and some slight change to merge them both in, AFAICT this is good to go.

RUN git config --global user.email "[email protected]"
RUN git config --global user.name "Not, APerson"
RUN git fetch origin pull/148/head:pr-148
RUN git merge pr-148
RUN git fetch origin pull/147/head:pr-147
RUN git merge pr-147

@roehling Do the current changes here work for your project?

[roehling]

LGTM

[svenevs]

Righto thanks for checking in 🙂