search

exasol / integration-test-docker-environment

A docker-based environment for integration tests with the EXASOL DB.
https://exasol.github.io/integration-test-docker-environment/
MIT License
6 stars 2 forks source link

Generate Sphinx documentation #255

Closed tomuben closed 1 year ago

tomuben commented 1 year ago

Background

We have now an API Layer which can be used by client projects to spawn the test environment, build test container, push test container and more. This API becomes more important because only with it one can start a test container in the test environment. It's very important to have proper documentation of the API functions provided by this project. Also, documentation of the other classes need to be well documented, because some functionality (Populate Data, Upload) can be used by clients.

Acceptance Criteria

  1. Setup a Github workflow which leverages https://github.com/exasol/sphinx-github-pages-generator to generate and deploy the sphinx documentation correctly.