You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Move all required conf.py variables to generated wrapped conf.py so default user conf.py is blank (#203)
* Move conf.py variables to wrapping conf.py so user conf.py only needs to add changes. Update README.
Signed-off-by: R Kent James <kent@caspia.com>
Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
* Consolidate template variables into a single, alphabetical definition.
Signed-off-by: R Kent James <kent@caspia.com>
Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
* Add an empty conf.py to testing in full_package to confirm that it works.
Signed-off-by: R Kent James <kent@caspia.com>
Generated-by: Portions of this commit may include code completion from github.copilot version 1.372.0 or later
---------
Signed-off-by: R Kent James <kent@caspia.com>
Copy file name to clipboardExpand all lines: README.md
+30-17Lines changed: 30 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Command-line tool for generating documentation for ROS 2 packages.
4
4
5
5
## Quick-start
6
6
7
-
This tool can be viewed from two perspectives: first from the perspective of a user wanting to building documentation for any given ROS 2 package in order to view it, and second from the perspective of package maintainers who need to write their documentation and configure how this tool works on their package.
7
+
This tool can be viewed from two perspectives: first from the perspective of a user wanting to build documentation for any given ROS 2 package in order to view it, and second from the perspective of package maintainers who need to write their documentation and configure how this tool works on their package.
8
8
9
9
### Build documentation for a ROS 2 package
10
10
@@ -25,7 +25,11 @@ The package directory that you specify must contain a single ROS 2 package that
25
25
There will be an `index.html` file in the output directory which you can open manually, or with this command:
26
26
27
27
```
28
-
rosdoc2 open ./doc_output/index.html
28
+
rosdoc2 open ./docs_output
29
+
```
30
+
then click through to the package name, then `index.html`. Or you can do that directly, filling in the package name, using:
31
+
```
32
+
rosdoc2 open ./docs_output/<package_name>/index.html
### Set up a ROS 2 package to be used with this tool
40
44
41
-
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.
45
+
In many cases, C/C++ or python packages require no configuration, and will work if you simply
46
+
layout your package in a standard configuration and the tool will do the rest.
42
47
43
-
However, if you want to provide additional documentation, like a conceptual overview or tutorials, then you will want to provide a Sphinx `conf.py` file and do that documentation in `.rst` files using Sphinx.
48
+
If you want to provide additional documentation, like a conceptual overview or tutorials,
49
+
you can provide those files in either restructured text (.rst) or markdown (.md) in a `doc/` folder.
50
+
It is also highly recommended that you provide a README file, which will be rendered on the package
51
+
documentation front page by rosdoc2 (and also by the other ROS documentation tool, rosindex).
44
52
45
-
Additionally, if you have a Python API then you will want to provide a Sphinx `conf.py`
53
+
Currently, official documentation builds for released packages are done automatically by the build system,
54
+
placing results under `https://docs.ros.org/en/<distro>/p/` for example [rolling](https://docs.ros.org/en/rolling/p/)
46
55
47
56
## Installation
48
57
49
-
`rosdoc2` can be installed from the [ROS repositories](https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debians.html#enable-required-repositories).
58
+
The official package documentation builds install rosdoc2 directly from its git repository, so the best way to test with rosdoc2 is
59
+
to install from source. Other methods are also available, though the rosdoc2 version there may be older.
60
+
61
+
### Installation from source
62
+
63
+
We recommend you install and use rosdoc2 it from a [virtualenv](https://docs.python.org/3/library/venv.html).
You may also install rosdoc2 from [PyPI](https://pypi.org/project/rosdoc2).
58
-
If you do so, we recommend you install and use it from a [virtualenv](https://docs.python.org/3/library/venv.html).
73
+
`rosdoc2` can be installed from the [ROS repositories](https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debians.html#enable-required-repositories).
59
74
60
75
```
61
-
python3 -m pip install rosdoc2
76
+
apt install -y python3-rosdoc2
62
77
```
63
78
64
-
####Installation from source
79
+
### Installation from PyPI
65
80
66
-
You can also use pip to install rosdoc2 from source.
67
-
Again, we recommend you install and use it from a [virtualenv](https://docs.python.org/3/library/venv.html).
81
+
You may also install rosdoc2 from [PyPI](https://pypi.org/project/rosdoc2).
82
+
If you do so, we recommend you install and use it from a [virtualenv](https://docs.python.org/3/library/venv.html).
0 commit comments