https://github.com/eprosima/integration-service-docs
Documentation related to Integration-Service
https://github.com/eprosima/integration-service-docs
Last synced: over 1 year ago
JSON representation
Documentation related to Integration-Service
- Host: GitHub
- URL: https://github.com/eprosima/integration-service-docs
- Owner: eProsima
- License: apache-2.0
- Created: 2018-09-25T06:02:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T06:08:06.000Z (almost 2 years ago)
- Last Synced: 2024-10-19T08:30:01.297Z (almost 2 years ago)
- Language: Makefile
- Homepage:
- Size: 18.1 MB
- Stars: 4
- Watchers: 7
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Documentation
[](https://github.com/eProsima/Integration-Service-docs/actions)
[*eProsima Integration Service*](https://github.com/eProsima/Integration-Service) is a Linux tool that enables 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, Integration Service can act as an intermediate message-passing tool that, by speaking a common language, centralizes and mediates the integration.
*Integration Service* is configured by means of a *YAML* text file, through which the user can provide a mapping between the topics and services handled by the middlewares of the systems involved.
## Commercial support
Looking for commercial support? Write us to info@eprosima.com
Find more about us at [eProsima’s webpage](https://eprosima.com/).
## Installation Guide
To generate the *eProsima Integration Service* documentation, you need to install some dependencies:
```bash
sudo apt update
sudo apt install -y git python3 python3-pip python3-sphinxcontrib.spelling doxygen
```
Once the requirements are fulfilled, you can generate the documentation with `colcon` following the next steps:
1. Clone the repository:
```bash
mkdir ~/is_docs_ws
cd ~/is_docs_ws
git clone https://github.com/eProsima/Integration-Service-docs src/integration-service-docs
```
2. Install the `python3` dependencies:
```bash
pip3 install -r src/integration-service-docs/docs/requirements.txt
```
3. Use the `repos` file to download *Integration Service* and all the *System Handles*:
```bash
vcs import src < src/integration-service-docs/integration-service-docs.repos
```
4. Use `colcon` to compile and generate the documentation:
```bash
colcon build --cmake-args -DBUILD_LIBRARY=OFF -DBUILD_API_REFERENCE=ON
```
It is recommended to use `colcon` to generate the documentation, but you can also create it using `sphinx` by following the next instructions:
```bash
git clone https://github.com/eProsima/Integration-Service-docs integration-service-docs
READTHEDOCS=True sphinx-build -b html -d build/doctrees docs build/html
```
## Read the Docs
The official documentation for the *eProsima Integration Service* can be accessed on [Read the Docs](https://integration-service.docs.eprosima.com/en/latest/).
## License
This repository is open-sourced under the *Apache-2.0* license. See the [LICENSE](LICENSE) file for more details.