Files

Kai Zimmermann 6095133019 Fix DMF docs and unnecessary content_type enforcements. (#792 )

* Fix DMF docs and unnecessary content_typ enforcements.

* One more error.

* Typo

2019-02-01 12:09:11 +01:00

2019-02-01 12:09:11 +01:00

2018-10-16 11:14:52 +02:00

2018-10-22 21:06:42 +02:00

cleanup.sh

2018-08-01 11:01:02 +02:00

config.toml

2018-10-16 16:19:32 +02:00

install-theme.sh

2018-08-23 13:29:08 +02:00

pom.xml

2018-08-01 11:01:02 +02:00

README.md

2018-08-01 11:01:02 +02:00

Eclipse hawkBit Documentation

The hawkBit documentation is built with Hugo using the Material theme. Compiling the documentation is not included within the regular Maven build.

Prerequisites

Install Hugo: see installing Hugo documentation on how to install Hugo.
Install hawkBit: run mvn install in the parent directory to generate the latest REST docs for hawkBit.

The following Maven targets are available in order to build and serve the documentation:

mvn install: i. Copies the generated REST docs to content/rest-api/ and ii. downloads the required Hugo theme
mvn site: Serve the documentation on localhost:1313/hawkbit/
mvn clean: Delete generated artifacts (REST docs, Hugo theme)

Note: Currently, only Unix/macOS is supported! For Windows, use the hugo commands in CMD.

In order to generate the /public folder, which can be put on a web-server, run the following command:

$ hugo