Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prevent multiple project specification #148

Merged
merged 2 commits into from
Feb 9, 2022

Conversation

florianhumblot
Copy link
Collaborator

Prevents multiple :project: tags from being added to a breathe directive.
Fixes the issue that PR #146 tries to prevent.

@svenevs
Copy link
Owner

svenevs commented Feb 8, 2022

This was successful for me as far as I can tell, at least the plethora of warnings described in #146 are gone. Their flight got cancelled due to snow/ice so we went and played in the snow this weekend, sorry for the delay 🙃

Dropping how I was testing here since ros is kind of a complicated beast on fedora that I don't want to deal with

FROM ros:rolling-ros-core AS base
RUN apt-get update && apt-get -y upgrade
RUN apt-get install -y \
  doxygen \
  git \
  graphviz \
  python3-dev \
  python3-pip
WORKDIR /deps
RUN git clone https://github.com/ros-infrastructure/rosdoc2.git
WORKDIR /deps/rosdoc2
RUN pip install .
RUN echo "rosdoc2: $(git rev-parse HEAD)"

WORKDIR /deps
RUN git clone --depth 1 https://github.com/ros2/rcl.git

WORKDIR /deps
RUN pip uninstall -y exhale

# change to pushed branch or whatever
RUN git clone --depth 1 https://github.com/svenevs/exhale.git
WORKDIR /deps/exhale
# comment these out to reproduce original failure
RUN git fetch origin pull/148/head:pr-148
RUN git checkout pr-148
RUN echo "exhale: $(git rev-parse HEAD)"
RUN git log -1 --pretty=%B
RUN pip install .

WORKDIR /deps/rcl/rcl_lifecycle
RUN rosdoc2 build --package-path ./

Could one of @hidmic @clalancette or @2bndy5 confirm this fixes current breakages as far as actual html output is concerned? I'm closing #146. Only warning was

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

which i'm looking into next / is unrelated to this.

@svenevs svenevs marked this pull request as ready for review February 8, 2022 03:34
@2bndy5
Copy link

2bndy5 commented Feb 8, 2022

I'm not part of the ROS team (despite how often I'm tapped for consulting on robotics projects). Also, I haven't been tracking the changes to this lib, so I'm embarrassingly unprepared to help here. Sorry.

@svenevs
Copy link
Owner

svenevs commented Feb 8, 2022

Oh I'm so sorry! No worries at all, thanks for the response 🙂 I'm prepping up the next release but recent changes broke them so want to unbreak.

Prevents multiple `:project:` tags from being added to a breathe directive.
Fixes the issue that PR svenevs#146 tries to prevent.
@svenevs
Copy link
Owner

svenevs commented Feb 9, 2022

I am merging this, I posted additional information for rosdoc2 in ros-infrastructure/rosdoc2#44 since this at least appears to work for most of their usage and for where it does not the wrapping needs to change.

Exhale is full of band-aids at this point, and I have a love-hate relationship with this project. This is as good as multiproject support is going to get for now since undoing exhale.configs as a module and making it an object is too much to deal with.

@svenevs svenevs merged commit 4efe0c9 into svenevs:master Feb 9, 2022
@florianhumblot florianhumblot deleted the patch-1 branch February 9, 2022 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants