From 26866f7e3da43862e6816c6253438fdb76c44639 Mon Sep 17 00:00:00 2001 From: Adam Heins Date: Wed, 28 Feb 2024 15:42:21 -0500 Subject: [PATCH] Bump to version 0.3.0. --- README.md | 14 ++++++++------ docs/src/conf.py | 2 +- package.xml | 2 +- pyproject.toml | 2 +- 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 166e89a..1b24cf0 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: ``` @@ -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 ``. On the command line, we could write ``` @@ -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 diff --git a/docs/src/conf.py b/docs/src/conf.py index dde9cb8..3dd62fc 100644 --- a/docs/src/conf.py +++ b/docs/src/conf.py @@ -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 diff --git a/package.xml b/package.xml index 7df946e..67acea0 100644 --- a/package.xml +++ b/package.xml @@ -2,7 +2,7 @@ xacrodoc - 0.2.0 + 0.3.0 Programmatically compile xacro files. Adam Heins Adam Heins diff --git a/pyproject.toml b/pyproject.toml index 4cbc0a6..3218ff2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 "] license = "MIT"