Skip to content

Commit

Permalink
Bump to version 0.3.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
adamheins committed Feb 28, 2024
1 parent d6a3c90 commit 26866f7
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 9 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# xacrodoc

xacrodoc is a tool for programmatically compiling
[xacro](https://github.com/ros/xacro)'d URDF files.
[xacro](https://github.com/ros/xacro)'d URDF files. It is fully functional
whether ROS is installed on the system or not.

Why?

* Compile xacro files without a ROS installation.
* Avoid the clutter of redundant compiled raw URDFs; only keep the xacro
source files.
* Programmatically compose multiple xacro files and apply subtitution
* Programmatically compose multiple xacro files and apply substitution
arguments to build a flexible URDF model.
* Convenient interfaces to provide URDF strings and URDF file paths as needed.
For example, many libraries (such as
Expand All @@ -20,8 +22,8 @@ See the documentation [here](https://xacrodoc.readthedocs.io/en/latest/).
## Installation

xacrodoc requires at least Python 3.8. Note that ROS *does not* need to be
installed on the system, but will also use its infrastructure to look for
packages if it is available.
installed on the system, but xacrodoc will also use its infrastructure to look
for packages if it is available.

From pip:
```
Expand Down Expand Up @@ -119,7 +121,7 @@ doc = xd.XacroDoc.from_includes(includes)

### Substitution arguments

We can also pass in substution arguments to xacro files. For example, suppose our
We can also pass in substitution arguments to xacro files. For example, suppose our
file `robot.urdf.xacro` contains the directive `<xacro:arg name="mass" default="1"/>`.
On the command line, we could write
```
Expand All @@ -132,7 +134,7 @@ from xacrodoc import XacroDoc
doc = XacroDoc.from_file("robot.urdf.xacro", subargs={"mass": "2"})
```

### Resolving filenames with respect to packages
### Resolving file names with respect to packages

Finally, one feature of URDF (not just xacro files) is that file names (e.g.,
for meshes) can be specified relative to a package by using
Expand Down
2 changes: 1 addition & 1 deletion docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
author = 'Adam Heins'

# The short X.Y version
version = '0.2.0'
version = '0.3.0'
# The full version, including alpha/beta/rc tags
release = version

Expand Down
2 changes: 1 addition & 1 deletion package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- Dummy package.xml so that ROS tools can identify this as a package. -->
<package format="2">
<name>xacrodoc</name>
<version>0.2.0</version>
<version>0.3.0</version>
<description>Programmatically compile xacro files.</description>
<maintainer email="mail@adamheins.com">Adam Heins</maintainer>
<author>Adam Heins</author>
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ line-length = 80

[tool.poetry]
name = "xacrodoc"
version = "0.2.0"
version = "0.3.0"
description = "Programmatically compile xacro files."
authors = ["Adam Heins <mail@adamheins.com>"]
license = "MIT"
Expand Down

0 comments on commit 26866f7

Please sign in to comment.