Giter VIP home page Giter VIP logo

stretch_uml's Introduction

Documentation

Click Here

TODO

  • Translate relative point on pgm to coordinate frame
  • Camera move subscriber
  • Map image to map location translation

Requirements

git clone [email protected]:PatrickCPE/stretch_uml.git PATHTOCATKIN/catkin_ws/

sudo apt-get install python3-pyqt5
sudo apt-get install qtcreator pyqt5-dev-tools
sudo apt-get install qttools5-dev-tools

cd PATHTOCATKIN/catkin_ws/src/stretch_uml
pip3 install -r requirements.txt

# ROS Noetic must be installed. Instructions for this are beyond scope.

Editing GUI Interface

cd stretch_uml/src/stretch_uml/
# Launch QT Designer
designer
# Open .ui file. Save edits when complete
pyuic5 -x stretch.ui -o stretch_ui_main_window.py

Usage

# Shell 1
roscore
# Shell 2
rosrun stretch_uml stretch_main_window.py
# Shell 3
rosrun stretch_uml map_subscriber

Building Docs

$ cd stretch_uml/docs
$ make clean # If needed
$ make html
$ xdg-open build/html/index.html # Open it in a browser

Updating Docs

$ cd stretch_uml/docs
$ sphinx-apidoc ../scripts/FOLDERNAME -o source/modules
$ sphinx-apidoc ../src/stretch_uml -o source/modules
$ cd source/modules
$ vim modules.rst
# Add the new .rst files name to the modules.rst file as shown
$ cd ..
$ vim conf.py
# append the syspath for any new module added as shown
  • Warning about duplicate contents is fine as long as it looks correct
  • Warning about document or segment not beginning with a transition is fine as long as it looks correct

Docs Initial Setup

$ cd stretch_uml
$ mkdir docs
$ cd docs
$ sphinx-quickstart
$ mkdir source
$ cd source
$ mkdir modules
$ sphinx-apidoc ../../scripts/PACKAGENAME -o modules
  • Add required modules to the conf.py file
  • Edit conf.py to support .md
  • Change theme to desired and set code highlight color
  • Rerun apidoc and adjust modules.py by hand when updating
  • Warning about duplicate contents is fine as long as it looks correct

stretch_uml's People

Contributors

patrickcpe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.