This repository holds the documentation for xOpera and is published on https://xlab-si.github.io/xopera-docs.
This was initially the documentation for xOpera TOSCA orchestration tool and has been later extended to document all the related xOpera tools and services.
For documenting xOpera orchestrator we use Sphinx documentation tool. Here we can render Sphinx Documentation from RST files and we use Read the Docs theme.
To test the documentation locally run the commands below:
# create and activate a new virualenv
python3 -m venv .venv && . .venv/bin/activate
# update pip and install Sphinx requirements
pip install --upgrade pip
pip install -r requirements.txt
# build the HTML documentation
sphinx-build -M html docs build
# build the Latex and PDF documentation
sphinx-build -M latexpdf docs buildAfter that you will found rendered documentation HTML files in build folder and you can open and view them inside
your browser.
This work is licensed under the Apache License 2.0.
You can contact the xOpera team by sending an email to xopera@xlab.si.
This project has received funding from the European Union’s Horizon 2020 research and innovation programme under Grant Agreements No. 825040 (RADON), No. 825480 (SODALITE) and No. 101000162 (PIACERE).