eProsima/SOSS-docs

SOSS Documentation

SOSS is a System-Of-Systems Synthesizer that allows communication among an arbitrary number of protocols that speak different languages.

If one has a number of complex systems and wills to combine them to create a larger, even more complex system, SOSS can act as an intermediate message-passing tool that, by speaking a common language, centralizes and mediates the integration.

For more information, check out the SOSS documentation. You can find all the source code on our GitHub repository.

1. Installation Guide
2. Getting Started
3. Generating documentation in other formats
4. Running documentation tests

Installation Guide

1. 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 \

2. Clone the repository

   cd ~
   git clone https://github.com/eProsima/SOSS-docs soss-docs

3. Create a virtual environment and install python3 dependencies

   cd ~/soss-docs
   python3 -m venv soss-docs-venv
   source soss-docs-venv/bin/activate
   pip3 install -r docs/requirements.txt

Getting Started

To generate the documentation in a HTML format for a specific branch of SOSS run:

cd ~/soss-docs
source soss-docs-venv/bin/activate
make html

Generating documentation in other formats

The documentation can be generated in several formats such as HTML, PDF, LaTex, etc. For a complete list of targets run:

cd ~/soss-docs
make help

Once you have selected a format, generate the documentation with:

cd ~/soss-docs
source soss-docs-venv/bin/activate
make <output_format>

Running documentation tests

This repository provides a set of tests that verify that:

1. The RST follows the style guidelines
2. There are no spelling errors
3. The HTML is built correctly

Run the tests by:

cd ~/soss-docs
source soss-docs-venv/bin/activate
make test

Contributing

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.