Skip to content

Fix TOC in docs#2236

Closed
Bhavin-umatiya wants to merge 1 commit intoros-controls:masterfrom
Bhavin-umatiya:fix/motion-primitives-toc-2216
Closed

Fix TOC in docs#2236
Bhavin-umatiya wants to merge 1 commit intoros-controls:masterfrom
Bhavin-umatiya:fix/motion-primitives-toc-2216

Conversation

@Bhavin-umatiya
Copy link
Copy Markdown
Contributor

Cherry-pick changes from 7b2462a to fix the broken motion_primitive_controller TOC.

  • Move README.md and userdoc.rst into doc/ subdirectory
  • Fix path in controllers_index.rst
  • Sort controller entries alphabetically
  • Add proper RST heading, description and warning
  • Split parameters into forward and trajectory sections
  • Fix relative paths for literalinclude and generate_parameter_library_details

Fixes #2216

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. Limited scope. Your PR should do one thing or one set of things. Avoid adding “random fixes” to PRs. Put those on separate PRs.
  2. Give your PR a descriptive title. Add a short summary, if required.
  3. Make sure the pipeline is green.
  4. Don’t be afraid to request reviews from maintainers.
  5. New code = new tests. If you are adding new functionality, always make sure to add some tests exercising the code and serving as live documentation of your original intention.

Cherry-pick changes from 7b2462a to fix the broken motion_primitive_controller TOC.

- Move README.md and userdoc.rst into doc/ subdirectory
- Fix path in controllers_index.rst
- Sort controller entries alphabetically
- Add proper RST heading, description and warning
- Split parameters into forward and trajectory sections
- Fix relative paths for literalinclude and generate_parameter_library_details

Fixes ros-controls#2216
@Bhavin-umatiya
Copy link
Copy Markdown
Contributor Author

I have submitted a PR for this issue: #2236.
Please let me know if any changes are needed.

@christophfroehlich
Copy link
Copy Markdown
Member

This is a duplicate of #2221, and pulling in changes from a PR which is not merged yet (there is no _from_trajectory_controller yet).

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

2 participants