Skip to content

Fix motion_primitive_controller TOC in docs#2221

Open
SouriRishik wants to merge 3 commits intoros-controls:masterfrom
SouriRishik:fix/motion-primitive-controller-toc
Open

Fix motion_primitive_controller TOC in docs#2221
SouriRishik wants to merge 3 commits intoros-controls:masterfrom
SouriRishik:fix/motion-primitive-controller-toc

Conversation

@SouriRishik
Copy link
Copy Markdown

@SouriRishik SouriRishik commented Mar 20, 2026

Fixes #2216

Changes

  • Reorder controllers alphabetically in doc/controllers_index.rst
  • Fix path for Motion Primitive Controller to motion_primitives_controllers/doc/userdoc.rst
  • Move README.md and userdoc.rst into motion_primitives_controllers/doc/
  • Fix relative paths in userdoc.rst and README.md after move

This cherrypicks the fix from commit 7b2462a into master.

Checklist

  • Limited scope — only fixes the TOC issue
  • Local tests pass
  • Clear commit message

@bmagyar
Copy link
Copy Markdown
Member

bmagyar commented Mar 20, 2026

I think the PR referenced on the original issue removed the readme file. I think that may be the better option, if we are happy with the docs already in the main doc file.

If we decide to stick with the readme, it should be in the package root.

@SouriRishik
Copy link
Copy Markdown
Author

SouriRishik commented Mar 20, 2026

I think the PR referenced on the original issue removed the readme file. I think that may be the better option, if we are happy with the docs already in the main doc file.

If we decide to stick with the readme, it should be in the package root.

I agree, removing the README seems like the cleaner approach since the content is already included in the doc files. I'll update the PR to remove it instead.

@SouriRishik
Copy link
Copy Markdown
Author

Also, is the doc8 pre-commit failure on rolling a known issue or something I need to fix on my end?

@christophfroehlich
Copy link
Copy Markdown
Member

the problem is mainly the heading level in the markdown file. have a look at the linked PR in the issue. the first of my commits should point you there. tests are not failing on master branch

@SouriRishik
Copy link
Copy Markdown
Author

Done, removed the README.md and inlined the essential content directly into userdoc.rst with proper RST formatting. Please have a look. thank you!

@SouriRishik
Copy link
Copy Markdown
Author

@bmagyar are the current changes good enough for solving the issue, if yes can we merge and close the PR?

@SouriRishik SouriRishik force-pushed the fix/motion-primitive-controller-toc branch from 1b1e32a to bf9c5a3 Compare March 26, 2026 21:16
@SouriRishik SouriRishik force-pushed the fix/motion-primitive-controller-toc branch from bf2f5f8 to 2942d73 Compare March 26, 2026 21:34
Copy link
Copy Markdown
Author

@SouriRishik SouriRishik left a comment

Choose a reason for hiding this comment

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

i think what i did changes in the readme and userdoc.rst were not relevant here so i just reverted those changes

@SouriRishik
Copy link
Copy Markdown
Author

@christophfroehlich i have made the required change and also the README and userdoc.rst is now untouched so that the information is as it is.

Copy link
Copy Markdown
Contributor

@thedevmystic thedevmystic left a comment

Choose a reason for hiding this comment

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

LGTM

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.

[Docs] motion_primitive_controller TOC is broken

4 participants