Skip to content

Commit

Permalink
Merge pull request #73 from rkent/allow-running-as-module
Browse files Browse the repository at this point in the history
Allow running as module
  • Loading branch information
tfoote authored Mar 26, 2024
2 parents e112a5f + 07057f6 commit ce98706
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ rosdoc2 open ./doc_output/index.html

For more advanced usage see the documentation.

It may be helpful during rosdoc2 development to run a version of rosdoc2 without installing it. This can be done
(after doing an initial normal install to make sure prerequisites are available) by running, from the rosdoc2 main directory:
```bash
python3 -m rosdoc2.main <options>
```

### Set up a ROS 2 package to be used with this tool

In many cases, C/C++ packages require no configuration, and will work if you simply layout your package in a standard configuration and the tool will do the rest.
Expand Down
4 changes: 4 additions & 0 deletions rosdoc2/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,7 @@ def main(sysargs=None):
# Finally call the subparser's main function with the processed args
# and the extras which the preprocessor may have returned
sys.exit(args.main(args) or 0)


if __name__ == '__main__':
main()

0 comments on commit ce98706

Please sign in to comment.