From f4c84f9aa08c546945fd08e6f445ec2a44a30ea3 Mon Sep 17 00:00:00 2001 From: Paul Makles Date: Sat, 21 Oct 2023 13:09:17 +0100 Subject: [PATCH] chore: update remaining references in documentation pkg --- documentation/README.md | 32 ++++++++++++------------ documentation/doc/EXAMPLE.md | 24 +++++++++--------- documentation/doc/USAGE.md | 6 ++--- documentation/scripts/generate_readme.py | 2 +- documentation/src/document_lasr/web.py | 2 +- 5 files changed, 33 insertions(+), 33 deletions(-) diff --git a/documentation/README.md b/documentation/README.md index 5c8e2fef4..80e701014 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,4 +1,4 @@ -# document_lasr +# documentation Package for documenting ROS packages in your current workspace. @@ -17,7 +17,7 @@ If you would like to view the documentation in the browser, ensure you have at [ View workspace documentation in the browser: ```bash -rosrun document_lasr view.py +rosrun documentation view.py ``` Please see the [example section](#example) to see how to document your package. @@ -25,13 +25,13 @@ Please see the [example section](#example) to see how to document your package. Document a single package from your current workspace: ```bash -rosrun document_lasr generate_readme.py ros_package_name +rosrun documentation generate_readme.py ros_package_name ``` Document all LASR packages in current workspace: ```bash -rosrun document_lasr generate_all.py +rosrun documentation generate_all_lasr.py ``` ## Example @@ -103,7 +103,7 @@ For this example, let's suppose you have a package `my_package`. \`\`\`bash roslaunch my_package my_service.launch \`\`\` - + 2. Start the example script \`\`\`bash @@ -113,19 +113,19 @@ For this example, let's suppose you have a package `my_package`. 5. Create the `doc/TECHNICAL.md` file. - This is up to you to figure out, but in this file you should provide a technical overview of how the package works. Include whatever you think is required for someone who would want to contribute to the package. + This is up to you to figure out, but in this file you should provide a technical overview of how the package works. Include whatever you think is required for someone who would want to contribute to the package. 6. Describe fields in messages / services / actions. - You should go through all of your `.msg`, `.srv`, and `.action` files in their respective folders, and add comments to each field. + You should go through all of your `.msg`, `.srv`, and `.action` files in their respective folders, and add comments to each field. - ``` - # the table we to check - uint8 table - --- - # whether the table is ready - bool result # (you can also put comments here) - ``` + ``` + # the table we to check + uint8 table + --- + # whether the table is ready + bool result # (you can also put comments here) + ``` 7. Add descriptions, examples and documentation to launch files. @@ -144,7 +144,7 @@ For this example, let's suppose you have a package `my_package`. ```xml - + @@ -153,7 +153,7 @@ For this example, let's suppose you have a package `my_package`. Finally, regenerate the README file: ```bash -rosrun document_lasr generate_readme.py my_package +rosrun documentation generate_readme.py my_package ``` ## Technical Overview diff --git a/documentation/doc/EXAMPLE.md b/documentation/doc/EXAMPLE.md index 2d8d5ab79..1bb34d5d9 100644 --- a/documentation/doc/EXAMPLE.md +++ b/documentation/doc/EXAMPLE.md @@ -65,7 +65,7 @@ For this example, let's suppose you have a package `my_package`. \`\`\`bash roslaunch my_package my_service.launch \`\`\` - + 2. Start the example script \`\`\`bash @@ -75,19 +75,19 @@ For this example, let's suppose you have a package `my_package`. 5. Create the `doc/TECHNICAL.md` file. - This is up to you to figure out, but in this file you should provide a technical overview of how the package works. Include whatever you think is required for someone who would want to contribute to the package. + This is up to you to figure out, but in this file you should provide a technical overview of how the package works. Include whatever you think is required for someone who would want to contribute to the package. 6. Describe fields in messages / services / actions. - You should go through all of your `.msg`, `.srv`, and `.action` files in their respective folders, and add comments to each field. + You should go through all of your `.msg`, `.srv`, and `.action` files in their respective folders, and add comments to each field. - ``` - # the table we to check - uint8 table - --- - # whether the table is ready - bool result # (you can also put comments here) - ``` + ``` + # the table we to check + uint8 table + --- + # whether the table is ready + bool result # (you can also put comments here) + ``` 7. Add descriptions, examples and documentation to launch files. @@ -106,7 +106,7 @@ For this example, let's suppose you have a package `my_package`. ```xml - + @@ -115,5 +115,5 @@ For this example, let's suppose you have a package `my_package`. Finally, regenerate the README file: ```bash -rosrun document_lasr generate_readme.py my_package +rosrun documentation generate_readme.py my_package ``` diff --git a/documentation/doc/USAGE.md b/documentation/doc/USAGE.md index de9fec483..e796af60b 100644 --- a/documentation/doc/USAGE.md +++ b/documentation/doc/USAGE.md @@ -1,7 +1,7 @@ View workspace documentation in the browser: ```bash -rosrun document_lasr view.py +rosrun documentation view.py ``` Please see the [example section](#example) to see how to document your package. @@ -9,11 +9,11 @@ Please see the [example section](#example) to see how to document your package. Document a single package from your current workspace: ```bash -rosrun document_lasr generate_readme.py ros_package_name +rosrun documentation generate_readme.py ros_package_name ``` Document all LASR packages in current workspace: ```bash -rosrun document_lasr generate_all.py +rosrun documentation generate_all_lasr.py ``` diff --git a/documentation/scripts/generate_readme.py b/documentation/scripts/generate_readme.py index 282b68fdb..b0428443a 100755 --- a/documentation/scripts/generate_readme.py +++ b/documentation/scripts/generate_readme.py @@ -4,7 +4,7 @@ # Determine package name if len(sys.argv) < 2: - print('Usage: rosrun document_lasr generate_readme.py ros_package_name') + print('Usage: rosrun documentation generate_readme.py ros_package_name') exit() else: package = sys.argv[1] diff --git a/documentation/src/document_lasr/web.py b/documentation/src/document_lasr/web.py index d044f0a22..14b8d76e1 100644 --- a/documentation/src/document_lasr/web.py +++ b/documentation/src/document_lasr/web.py @@ -7,7 +7,7 @@ def configure_web(): # Determine dest folder - PKG = r.get_path('document_lasr') + PKG = r.get_path('documentation') WEB_DIR = os.path.abspath(os.path.join(PKG, 'web')) DOC_DIR = os.path.join(WEB_DIR, 'docs', 'packages') TASK_DIR = os.path.join(WEB_DIR, 'docs', 'tasks')