Generate Markdown Docs for Parameters #111
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>
…nerate_parameter_library into add-generate-parameter-library-python-module
pac48
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.yamlNote: 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