This repository holds the documentation for the lbr-stack.
TODO: update fri repo source vcs
To build locally:
- Clone this repository
git clone --recursive git@github.com:lbr-stack/lbr_stack_doc.git
cd lbr_stack_doc
- Clone the
lbr_fri_ros2_stack
, e.g. via (this uses vcs)
wget https://raw.githubusercontent.com/lbr-stack/lbr_fri_ros2_stack/humble/lbr_fri_ros2_stack/repos-fri-1.15.yaml
vcs import doc/source < repos.yaml
- In conf.py change
f"doxysphinx build . $READTHEDOCS_OUTPUT/html {doxyfile}", shell=True
to
f"doxysphinx build . html {doxyfile}", shell=True
Next, go to doc/source and run
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . html
Open and browse the documentation by opening doc/source/html/index.html
.
To build the paper via Docker, run
docker run --rm -it \
-v $PWD:/data \
-u $(id -u):$(id -g) \
openjournals/inara \
-o pdf,crossref,preprint \
paper/paper.md
inside the lbr_stack_doc
repository.
If you enjoyed using this repository for your work, we would really appreciate ❤️ if you could cite it, as it helps us to continue offering support.
@misc{huber2023lbrstack,
title={LBR-Stack: ROS 2 and Python Integration of KUKA FRI for Med and IIWA Robots},
author={Martin Huber and Christopher E. Mower and Sebastien Ourselin and Tom Vercauteren and Christos Bergeles},
year={2023},
eprint={2311.12709},
archivePrefix={arXiv},
primaryClass={cs.RO}
}
This work was supported by core and project funding from the Wellcome/EPSRC [WT203148/Z/16/Z; NS/A000049/1; WT101957; NS/A000027/1].
This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 101016985 (FAROS project).