{"id":27301493,"url":"https://github.com/eprosima/integration-service-docs","last_synced_at":"2025-04-12T01:46:29.685Z","repository":{"id":48686947,"uuid":"150215235","full_name":"eProsima/Integration-Service-docs","owner":"eProsima","description":"Documentation related to Integration-Service","archived":false,"fork":false,"pushed_at":"2024-10-17T06:08:06.000Z","size":18939,"stargazers_count":4,"open_issues_count":4,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-10-19T08:30:01.297Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eProsima.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-25T06:02:50.000Z","updated_at":"2024-10-17T06:08:08.000Z","dependencies_parsed_at":"2024-10-19T05:35:55.772Z","dependency_job_id":"97202dcf-5905-4075-bf7f-01b04330a9a3","html_url":"https://github.com/eProsima/Integration-Service-docs","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eProsima%2FIntegration-Service-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eProsima%2FIntegration-Service-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eProsima%2FIntegration-Service-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eProsima%2FIntegration-Service-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eProsima","download_url":"https://codeload.github.com/eProsima/Integration-Service-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505952,"owners_count":21115354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-12T01:46:26.474Z","updated_at":"2025-04-12T01:46:29.673Z","avatar_url":"https://github.com/eProsima.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://integration-service.docs.eprosima.com/\"\u003e\u003cimg src=\"https://github.com/eProsima/Integration-Service/blob/main/docs/images/logo.png?raw=true\" hspace=\"8\" vspace=\"2\" height=\"100\" \u003e\u003c/a\u003e\n\n# Documentation\n\n[![Integration Service CI Status](https://github.com/eProsima/Integration-Service-docs/actions/workflows/ci.yml/badge.svg)](https://github.com/eProsima/Integration-Service-docs/actions)\n\n\n[*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.\n\nIf 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.\n\n*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.\n\n## Commercial support\n\nLooking for commercial support? Write us to info@eprosima.com\n\nFind more about us at [eProsima’s webpage](https://eprosima.com/).\n\n## Installation Guide\n\nTo generate the *eProsima Integration Service* documentation, you need to install some dependencies:\n\n```bash\n    sudo apt update\n    sudo apt install -y git python3 python3-pip python3-sphinxcontrib.spelling doxygen\n```\n\nOnce the requirements are fulfilled, you can generate the documentation with `colcon` following the next steps:\n\n1. Clone the repository:\n\n    ```bash\n        mkdir ~/is_docs_ws\n        cd ~/is_docs_ws\n        git clone https://github.com/eProsima/Integration-Service-docs src/integration-service-docs\n    ```\n\n2. Install the `python3` dependencies:\n\n    ```bash\n        pip3 install -r src/integration-service-docs/docs/requirements.txt\n    ```\n\n3. Use the `repos` file to download *Integration Service* and all the *System Handles*:\n\n    ```bash\n        vcs import src \u003c src/integration-service-docs/integration-service-docs.repos\n    ```\n\n4. Use `colcon` to compile and generate the documentation:\n\n    ```bash\n        colcon build --cmake-args -DBUILD_LIBRARY=OFF -DBUILD_API_REFERENCE=ON\n    ```\n\nIt is recommended to use `colcon` to generate the documentation, but you can also create it using `sphinx` by following the next instructions:\n\n```bash\n    git clone https://github.com/eProsima/Integration-Service-docs integration-service-docs\n    READTHEDOCS=True sphinx-build -b html -d build/doctrees docs build/html\n```\n\n\n## Read the Docs\n\nThe official documentation for the *eProsima Integration Service* can be accessed on [Read the Docs](https://integration-service.docs.eprosima.com/en/latest/).\n\n## License\n\nThis repository is open-sourced under the *Apache-2.0* license. See the [LICENSE](LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feprosima%2Fintegration-service-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feprosima%2Fintegration-service-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feprosima%2Fintegration-service-docs/lists"}