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

Generate Markdown Docs for Parameters #111

Merged
merged 43 commits into from
May 16, 2023

Conversation

pac48
Copy link
Collaborator

@pac48 pac48 commented May 16, 2023

This PR adds a Python program called generate_rst.py that generates documentation from a yaml file in .rst format.

Try running the following to see the output:
python3 generate_rst.py --output_markdown_file ./out.md --input_yaml_file gripper_action_controller_parameters.yaml
Note: this example requires you to be in the generate_parameter_library/generate_parameter_library_py/generate_parameter_library_py directory with this file downloaded gripper_action_controller_parameters.yaml

pac48 and others added 30 commits July 28, 2022 19:21
Signed-off-by: Tyler Weaver <tylerjw@gmail.com>
…library

� Conflicts:
�	example/src/main.cpp
�	generate_parameter_library_py/generate_parameter_library_py/main.py
Signed-off-by: Tyler Weaver <tyler@picknik.ai>
@pac48 pac48 changed the title Generate RST Docs for Parameters Generate Markdown Docs for Parameters May 16, 2023
Copy link
Contributor

@tylerjw tylerjw left a comment

Choose a reason for hiding this comment

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

let's go 🚀

@tylerjw tylerjw merged commit b5d4640 into PickNikRobotics:main May 16, 2023
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.

2 participants