Skip to content

Conversation

@EduPonz
Copy link

@EduPonz EduPonz commented Jun 5, 2024

Description

This PR makes the RDT generation to fail if either of the doxygen or swig commands fails. Not checking them was causing the documentation to build with API reference errors.

@Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x

Related implementation PR:

NOTE: As RTD build is not ready to take the appropriate Fast DDS branch and will choose master, the build will failed until eProsima/Fast-DDS#4896 is merged. I've verified on a Ubuntu 20.04 docker that the doxygen is generated without errors with that Fast DDS PR.

Contributor Checklist

  • Commit messages follow the project guidelines.
  • N/A: Code snippets related to the added documentation have been provided.
  • Documentation tests pass locally.
  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • CI passes without warnings or errors.

Signed-off-by: eduponz <eduardoponz@eprosima.com>
@EduPonz
Copy link
Author

EduPonz commented Jun 5, 2024

@richiprosima please test_3 docs

@EduPonz EduPonz merged commit 0974196 into master Jun 5, 2024
@EduPonz EduPonz deleted the hotfix/doxygen_errors branch June 5, 2024 10:51
@EduPonz
Copy link
Author

EduPonz commented Jun 5, 2024

@Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x

@mergify
Copy link

mergify bot commented Jun 5, 2024

backport 2.14.x 2.13.x 2.10.x 2.6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jun 5, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
mergify bot pushed a commit that referenced this pull request Jun 5, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
mergify bot pushed a commit that referenced this pull request Jun 5, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
mergify bot pushed a commit that referenced this pull request Jun 5, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
Mario-DL pushed a commit that referenced this pull request Jun 27, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
EduPonz added a commit that referenced this pull request Jul 2, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
EduPonz added a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
EduPonz added a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>

* Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>

* Refs #21114: TODO DROP - Check against Fast DDS branch

Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>

* Revert "Refs #21114: TODO DROP - Check against Fast DDS branch"

This reverts commit fd27b9f.

Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: JesusPoderoso <jesuspoderoso@eprosima.com>
EduPonz added a commit that referenced this pull request Jul 3, 2024
Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
EduPonz added a commit that referenced this pull request Jul 3, 2024
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <eduardoponz@eprosima.com>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <eduardoponz@eprosima.com>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>

* Set English as doc language

Signed-off-by: eduponz <eduardoponz@eprosima.com>

---------

Signed-off-by: eduponz <eduardoponz@eprosima.com>
Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
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