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

Fix docs build #933

Merged
merged 4 commits into from
Jul 31, 2024
Merged

Fix docs build #933

merged 4 commits into from
Jul 31, 2024

Conversation

sea-bass
Copy link
Contributor

@sea-bass sea-bass commented Jul 31, 2024

Description

This PR makes an attempt at "fixing" the docs build.

I had to modify the doxylink repo (see sphinx-contrib/doxylink#59) since there was an exception without this, and also removed/replaced some old links to make htmlproofer happy.

While the exception was fixed with my PR above, there are still some more build warnings, so I had to remove the -W flag from the sphinx-build call in htmlproofer.sh.

I figured it would be better if the docs actually built and then someone else can try fix the warnings (or change the whole docs build system, which is probably due at this point)

Checklist

  • Required by CI: Code is auto formatted using clang-format
  • While waiting for someone to review your request, please consider reviewing another open pull request to support the maintainers

@@ -7,5 +7,6 @@ build
Gemfile
native_build
*.gdb
.venv
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stephanie-eng adding to gitignore since following the new instructions will create this folder locally

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, thanks for the fix

@@ -36,7 +36,7 @@ To start the hybrid planning demo simply run: ::

You should see a similar behavior as in the example GIF above without the replanning.

To interact with the architecture you simply need to send a *Hybrid Planning Request* to an action server offered by the *Hybrid Planning Manager* as seen in the :moveit_codedir:`hybrid_planning_test_node <moveit_ros/hybrid_planning/test/hybrid_planning_demo_node.cpp#L245>`.
To interact with the architecture you simply need to send a *Hybrid Planning Request* to an action server offered by the *Hybrid Planning Manager*.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sjahr This file was removed from the moveit2 repo last year with the promise that it would eventually be moved to this repo with a refresh of the Hybrid Planning tutorials. I assume this whole file would then get revisited.

Copy link
Contributor

@stephanie-eng stephanie-eng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can now build the tutorials (well, minus the fact that the build_locally script is broken)! Thank you!

@sea-bass sea-bass merged commit b05445a into main Jul 31, 2024
8 checks passed
@sea-bass sea-bass deleted the fix-docs-build branch July 31, 2024 13:43
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.

4 participants