Unverified Commit ad9438ca authored by Philipp Sommer's avatar Philipp Sommer
Browse files

minor fix for building the docs

parent 4724a1ea
Pipeline #45744 passed with stage
in 2 minutes and 22 seconds
......@@ -6,9 +6,9 @@
## dasf-messaging-python
`DASF: Messaging Python` is part of the Data Analytics Software Framework (DASF, https://git.geomar.de/digital-earth/dasf),
developed at the GFZ German Research Centre for Geosciences (https://www.gfz-potsdam.de).
It is funded by the Initiative and Networking Fund of the Helmholtz Association through the Digital Earth project
`DASF: Messaging Python` is part of the Data Analytics Software Framework (DASF, https://git.geomar.de/digital-earth/dasf),
developed at the GFZ German Research Centre for Geosciences (https://www.gfz-potsdam.de).
It is funded by the Initiative and Networking Fund of the Helmholtz Association through the Digital Earth project
(https://www.digitalearth-hgf.de/).
`DASF: Messaging Python` is a RPC (remote procedure call) wrapper library for the python programming language. As part of the data analytics software framework DASF, it implements the DASF RPC messaging protocol. This message broker based RPC implementation supports the integration of algorithms and methods implemented in python in a distributed environment. It utilizes pydantic (https://pydantic-docs.helpmanual.io/) for data and model validation using python type annotations. Currently the implementation relies on Apache Pulsar (https://pulsar.apache.org/) as a central message broker instance.
......@@ -29,7 +29,10 @@ see https://git.geomar.de/digital-earth/dasf/dasf-messaging-python/-/blob/master
#### **Howto make the docs**
Cd into the `docs` subfolder and execute
First, make sure you have [graphviz](https://www.graphviz.org/download/)
installed, and run `pip install -r docs/requirements.txt`.
Then change directories into the `docs` subfolder and execute
```bash
make html
......@@ -41,7 +44,7 @@ The built HTML documentation can be access via `docs/_build/html/index.html`.
### Service Desk
For everyone without a Geomar Gitlab account, we setup the Service Desk feature for this repository.
It lets you communicate with the developers via a repository specific eMail address. Each request will be tracked via the Gitlab issuse tracker.
It lets you communicate with the developers via a repository specific eMail address. Each request will be tracked via the Gitlab issuse tracker.
In order to send a follow-up message, simply reply to the corresponding notification eMail.
eMail: [gitlab+digital-earth-dasf-dasf-messaging-python-1576-issue-@git-issues.geomar.de](mailto:gitlab+digital-earth-dasf-dasf-messaging-python-1576-issue-@git-issues.geomar.de)
......@@ -125,12 +128,12 @@ limitations under the License.
```
### Contact
Dr.-Ing. Daniel Eggert
Dr.-Ing. Daniel Eggert
eMail: <daniel.eggert@gfz-potsdam.de>
Helmholtz Centre Potsdam GFZ German Research Centre for Geoscienes
Section 1.4 Remote Sensing & Geoinformatics
Telegrafenberg
14473 Potsdam
Germany
Helmholtz Centre Potsdam GFZ German Research Centre for Geoscienes
Section 1.4 Remote Sensing & Geoinformatics
Telegrafenberg
14473 Potsdam
Germany
Supports Markdown
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