Skip to content

Commit bb924ce

Browse files
committed
Update documentation
1 parent 1853f49 commit bb924ce

File tree

5 files changed

+12
-6
lines changed

5 files changed

+12
-6
lines changed

docs/pages/developer_guide/_shared/prerequisites/build_or_pull_gisnav_docker.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
* You must either build the ``gisnav`` Docker image from local sources, or pull
2-
it from the GitHub Container Registry (GHCR):
1+
* You must have either built the ``gisnav`` Docker image from local sources, or
2+
pulled it it from the container registry:
33

44
.. tab-set::
55

docs/pages/developer_guide/development/test_gisnav.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ directory on all files, not just the ones staged for commit:
4646
.. code-block:: bash
4747
:caption: Run static analysis
4848
49+
cd ~/colcon_ws/src/gisnav/docker
4950
docker compose -p gisnav run gisnav make test-static
5051
5152
Launch tests
@@ -73,6 +74,7 @@ the nodes, like a node not starting properly or crashing soon after startup.
7374
.. code-block:: bash
7475
:caption: Run launch tests
7576
77+
cd ~/colcon_ws/src/gisnav/docker
7678
docker compose -p gisnav run gisnav make test-launch
7779
7880
You can also try running only specific launch tests with commands like below:

docs/pages/glossary.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -521,6 +521,9 @@ ____________________________________________________
521521
GCS
522522
:term:`Ground Control Station`
523523

524+
GHCR
525+
GitHub Container Registry
526+
524527
GIS
525528
Geographic Information System
526529

gisnav/gisnav/extensions/qgis_node.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
This node enables real-time visualization of data in QGIS, aiding in
77
development and debugging.
88
9+
.. note::
10+
This node depends on :class:`.MockGPSNode`.
11+
912
.. todo::
1013
Currently SensorGps message (PX4) only (implement GPSINPUT to support
1114
ArduPilot)

gisnav/gisnav/extensions/rviz_node.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33
:term:`RViz`. The node simplifies data visualization from across different
44
parts of the :term:`core` system, aiding development and debugging.
55
6-
The below graph depicts how :class:`.RVizNode` publishes the :term:`vehicle` and
7-
:term:`ground track` :term:`path` that can be susbcribed to and visualized by
8-
:term:`RViz`, making it easier to see where GISNav thinks the vehicle is compared
9-
to where the vehicle :term:`navigation filter` thinks it is:
6+
.. todo::
7+
Update this node after redesign - currently does not work
108
"""
119
from collections import deque
1210
from typing import Final, Optional

0 commit comments

Comments
 (0)