moveit2_tutorials icon indicating copy to clipboard operation
moveit2_tutorials copied to clipboard

Fix workaround for multiversion overwriting API html

Open henningkayser opened this issue 1 year ago • 2 comments

We are currently deploying the API docs by first building the pages in separate build jobs (including Doxygen and Python autodocs API) and then copying the build artifacts into the multiversion build directory. The multiversion build then rebuilds the pages, successfully picking up the doxygen tags, but obviously failing to recreate the autodoc references. This is not really a problem since they are provided with the copied build artifacts, but the Python API html remain emtpy and overwrites the build artifacts version.

Current Workaround:

Problems:

  • The Python API pages won't have the version switcher included by multiversion
  • We can't use the autodoc roles for referencing the API from tutorials without using the same workaround. Multiversion will fail for all autodoc rules without notice even though they would function well on local builds.

These are not critical or urgent, but somewhat annoying so we should probably investigate alternatives to multiversion that make it easier to support our current workflow. For now, we will have to "hardcode" references to the Python API docs, and we should add adequate instructions for that.

henningkayser avatar Apr 15 '23 11:04 henningkayser

@rhaschke I am going to look into whether we can use this same approach to deploy python docs for MoveIt 1.

PeterMitrano avatar Apr 15 '23 17:04 PeterMitrano

Another low-priority problem I think I've found:

On this page, the link to "View on github" gives a 404, trying to link to this page.

PeterMitrano avatar Apr 15 '23 17:04 PeterMitrano