eProsima Shapes Demo is an application in which Publishers and Subscribers are shapes of different colors and sizes moving on a board. Each shape refers to its own topic: Square, Triangle or Circle. A single instance of the eProsima Shapes Demo can publish on or subscribe to several topics at a time.
Looking for commercial support? Write us to [email protected]
Find more about us at eProsima’s webpage.
eProsima Shapes Demo can be used to demonstrate the capabilities of eProsima Fast DDS or as a proof of interoperability with other RTPS-compliant implementations.
For more information about the application, check out the eProsima Shapes Demo documentation. You can find all the application's source code on our GitHub repository.
- Installation Guide
- Getting Started
- Generating documentation in other formats
- Running documentation tests
-
In order to build and test the documentation, some dependencies must be installed beforehand:
sudo apt update sudo apt install -y \ git \ python3 \ python3-pip \ python3-venv \ python3-sphinxcontrib.spelling \
-
Clone the repository
cd ~ git clone https://github.com/eProsima/Shapes-Demo-Docs shapes-demo-docs
-
Create a virtual environment and install python3 dependencies
cd ~/shapes-demo-docs python3 -m venv shapes-demo-docs-venv source shapes-demo-docs-venv/bin/activate pip3 install -r docs/requirements.txt
To generate the documentation in a HTML format for a specific branch of eProsima Shapes Demo run:
cd ~/shapes-demo-docs
source shapes-demo-docs-venv/bin/activate
make html
The documentation can be generated in several formats such as HTML, PDF, LaTex, etc. For a complete list of targets run:
cd ~/shapes-demo-docs
make help
Once you have selected a format, generate the documentation with:
cd ~/shapes-demo-docs
source shapes-demo-docs-venv/bin/activate
make <output_format>
This repository provides a set of tests that verify that:
- The RST follows the style guidelines
- There are no spelling errors
- The HTML is built correctly
Run the tests by:
cd ~/shapes-demo-docs
source shapes-demo-docs-venv/bin/activate
make test
If you are interested in making some contributions, either in the form of an issue or a pull request, please refer to our Contribution Guidelines.