Fix motion_primitive_controller TOC in docs#2221
Fix motion_primitive_controller TOC in docs#2221SouriRishik wants to merge 3 commits intoros-controls:masterfrom
Conversation
|
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. |
|
Also, is the doc8 pre-commit failure on rolling a known issue or something I need to fix on my end? |
|
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 |
|
Done, removed the README.md and inlined the essential content directly into userdoc.rst with proper RST formatting. Please have a look. thank you! |
|
@bmagyar are the current changes good enough for solving the issue, if yes can we merge and close the PR? |
1b1e32a to
bf9c5a3
Compare
bf2f5f8 to
2942d73
Compare
SouriRishik
left a comment
There was a problem hiding this comment.
i think what i did changes in the readme and userdoc.rst were not relevant here so i just reverted those changes
|
@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. |
Fixes #2216
Changes
doc/controllers_index.rstmotion_primitives_controllers/doc/userdoc.rstREADME.mdanduserdoc.rstintomotion_primitives_controllers/doc/userdoc.rstandREADME.mdafter moveThis cherrypicks the fix from commit 7b2462a into master.
Checklist