Commit dcfe6414 authored by Maximilian Dolling's avatar Maximilian Dolling

adopting doc for sphinx

parent a4c749ce
......@@ -11,7 +11,7 @@ pages:
- test:docs
before_script:
- apk add make
- pip install -U sphinx sphinx-rtd-theme
- pip install -U sphinx sphinx-rtd-theme PyYAML recommonmark
script:
- cd docs
- make html
......
......@@ -104,7 +104,7 @@ test:docs:
- sqa
before_script:
- apk add make
- pip install -U sphinx sphinx-rtd-theme
- pip install -U sphinx sphinx-rtd-theme PyYAML recommonmark
script:
- cd docs
- make html
......
......@@ -44,21 +44,21 @@ The software you want to run the services on **must** be a [git](https://git-scm
## Usage
Some of the services require a config file.
To see which, take a look at the [service description](doc/doc_service_description.md)
To see which, take a look at the [service description](docs/pages/services.md)
Running the services via Gitlab CI/CD is the recommended solution.
It keeps the report up to date, every time the project is changed.
You can read more about how it is set up [here](doc/doc_usage_ci.md).
You can read more about how it is set up [here](docs/pages/usage_ci.md).
Running it on you local machine is easier to set up.
Therefore it must be triggered manually before every release.
You can read more about how it is set up [here](doc/doc_usage_local.md).
You can read more about how it is set up [here](docs/pages/usage_local.md).
---
## Service Description
You can find a detailed description of all implemented services [here](doc/doc_service_description.md).
You can find a detailed description of all implemented services [here](docs/pages/services.md).
---
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment