Skip to content

Commit

Permalink
chore: update remaining references in documentation pkg
Browse files Browse the repository at this point in the history
  • Loading branch information
insertish committed Oct 21, 2023
1 parent e2ded26 commit f4c84f9
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 33 deletions.
32 changes: 16 additions & 16 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# document_lasr
# documentation

Package for documenting ROS packages in your current workspace.

Expand All @@ -17,21 +17,21 @@ 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.

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
Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -144,7 +144,7 @@ For this example, let's suppose you have a package `my_package`.

```xml
<launch>
<arg name="package" default="document_lasr" doc="Package to document" />
<arg name="package" default="documentation" doc="Package to document" />
<arg name="set_me_to_anything" doc="This is an example argument without a default" />
<arg name="hidden_arg" value="this won't show up" />
</launch>
Expand All @@ -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
Expand Down
24 changes: 12 additions & 12 deletions documentation/doc/EXAMPLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -106,7 +106,7 @@ For this example, let's suppose you have a package `my_package`.

```xml
<launch>
<arg name="package" default="document_lasr" doc="Package to document" />
<arg name="package" default="documentation" doc="Package to document" />
<arg name="set_me_to_anything" doc="This is an example argument without a default" />
<arg name="hidden_arg" value="this won't show up" />
</launch>
Expand All @@ -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
```
6 changes: 3 additions & 3 deletions documentation/doc/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
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.

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
```
2 changes: 1 addition & 1 deletion documentation/scripts/generate_readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion documentation/src/document_lasr/web.py
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down

0 comments on commit f4c84f9

Please sign in to comment.