3. Documentation

The Datagerry documentation is created using Sphinx.

3.1. Generation

In the case of a push or merge into one of the productive or development branches, the documentation is automatically generated via our continuous integration. Depending on the publication method, the documentation is then available as HTML source under /docs/_build/. Alternatively, the documentation can also be created manually using the included make file.

3.2. Approach

Since the documentation consists of pure HTML, it can be accessed directly via the index.html in the directory /docs/_build in a browser. Alternatively, the documentation is delivered for every running instance at https://yourdomain.com/docs/ .

4. Process Management — DATAGERRY bugfix-NET-981_render-throws-doc-gen-error-50b819b0089ce5ccf8219d4d3478d9417747bb66 documentation

4. Process Management

The DATAGERRY application consists of mulitple services. Each service is a Python process. The ProcessManager (cmdb.process_management.process_manager.ProcessManager) will start and stop all services in the correct order.

A services needs to implement the AbstractCmdbService class (cmdb.process_management.service.AbstractCmdbService).

4.1. adding a new service

To add a new service to DATAGERRY, write your own implementation of AbstractCmdbService and add a service definition to ProcessManager.