{"id":22230156,"url":"https://github.com/xlab-si/xopera-docs","last_synced_at":"2026-05-04T04:31:40.606Z","repository":{"id":46721707,"uuid":"266053669","full_name":"xlab-si/xopera-docs","owner":"xlab-si","description":"xOpera project documentation","archived":false,"fork":false,"pushed_at":"2024-09-03T21:09:09.000Z","size":7647,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-30T08:17:15.572Z","etag":null,"topics":["ansible","automation","docs","documentation","orchestration","python","sphinx","tosca"],"latest_commit_sha":null,"homepage":"https://xlab-si.github.io/xopera-docs/","language":null,"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/xlab-si.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}},"created_at":"2020-05-22T08:03:22.000Z","updated_at":"2024-01-29T10:27:24.000Z","dependencies_parsed_at":"2022-09-06T17:00:13.883Z","dependency_job_id":null,"html_url":"https://github.com/xlab-si/xopera-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fxopera-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fxopera-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fxopera-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlab-si%2Fxopera-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xlab-si","download_url":"https://codeload.github.com/xlab-si/xopera-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245431708,"owners_count":20614182,"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":["ansible","automation","docs","documentation","orchestration","python","sphinx","tosca"],"created_at":"2024-12-03T01:14:29.921Z","updated_at":"2026-05-04T04:31:35.586Z","avatar_url":"https://github.com/xlab-si.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# xOpera documentation\nThis repository holds the documentation for xOpera and is published on https://xlab-si.github.io/xopera-docs.\n\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/xlab-si/xopera-docs/xOpera%20docs%20workflow?label=ci/cd)](https://github.com/xlab-si/xopera-docs/actions/workflows/docs.yaml)\n[![GitHub deployments](https://img.shields.io/github/deployments/xlab-si/xopera-docs/github-pages?label=gh-pages)](https://github.com/xlab-si/xopera-docs/deployments)\n[![GitHub contributors](https://img.shields.io/github/contributors/xlab-si/xopera-docs)](https://github.com/xlab-si/xopera-docs/graphs/contributors)\n\n## Table of Contents\n  - [Description](#purpose-and-description)\n  - [Local building and testing](#local-building-and-testing)\n  - [License](#license)\n  - [Contact](#contact)\n  - [Acknowledgement](#acknowledgement)\n\n## Purpose and description\nThis was initially the documentation for [xOpera TOSCA orchestration tool] and has been later extended to document all \nthe related xOpera tools and services.\n\n## Local building and testing\nFor documenting xOpera orchestrator we use [Sphinx documentation tool].\nHere we can render Sphinx Documentation from RST files and we use [Read the Docs] theme.\n\nTo test the documentation locally run the commands below:\n\n```console\n# create and activate a new virualenv\npython3 -m venv .venv \u0026\u0026 . .venv/bin/activate\n\n# update pip and install Sphinx requirements\npip install --upgrade pip\npip install -r requirements.txt\n\n# build the HTML documentation\nsphinx-build -M html docs build\n\n# build the Latex and PDF documentation\nsphinx-build -M latexpdf docs build\n```\n\nAfter that you will found rendered documentation HTML files in `build` folder and you can open and view them inside \nyour browser. \n\n## License\nThis work is licensed under the [Apache License 2.0].\n\n## Contact\nYou can contact the xOpera team by sending an email to [xopera@xlab.si].\n\n## Acknowledgement\nThis project has received funding from the European Union’s Horizon 2020 research and innovation programme under Grant \nAgreements No. 825040 ([RADON]), No. 825480 ([SODALITE]) and No. 101000162 ([PIACERE]).\n\n[xOpera TOSCA orchestration tool]: https://github.com/xlab-si/xopera-opera\n[Sphinx documentation tool]: https://www.sphinx-doc.org/en/master/\n[Read the Docs]: https://readthedocs.org/\n[Apache License 2.0]: https://www.apache.org/licenses/LICENSE-2.0\n[xopera@xlab.si]: mailto:xopera@xlab.si\n[RADON]: http://radon-h2020.eu\n[SODALITE]: http://www.sodalite.eu/\n[PIACERE]: https://www.piacere-project.eu/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlab-si%2Fxopera-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxlab-si%2Fxopera-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlab-si%2Fxopera-docs/lists"}