Documentation

1. Concept

The OpenEMS Documentation is built with Antora .

OpenEMS Files and Documentation are separated on two different repositories.

The UI was slightly modified to fit our needs.

For more Information regarding AsciiDoc and Antora see their Docs.

2. Edit a page

If you want to edit a Docs - Page just click on 'Edit this Page' in the upper right corner to edit the page you are currently visiting.

Edit the Page according to your ideas and commit your changes.

You will see the changes you have made after our frequent Docs - Update.

3. Add a page

To add a page, clone the OpenEMS Repository (preferably Source Tree) and open it with a Code Editor (preferably Visual Studio Code).

  1. Go to doc/modules/ROOT/pages and create a .adoc file with the desired name.

  2. Go to doc/modules/ROOT/nav.adoc and add your page with the correct filename to the nav file.

4. Build Docs

To build the docs, clone the OpenEMS Repository (preferably Source Tree) and open it with a Code Editor (preferably Visual Studio Code).

NodeJS has to be installed
Build the documents:

Open the integrated terminal, change to the root directory and type

gradlew buildAntoraDocs

Docs should be building.. the finished HTML Folder can be found in your local 'build' folder (inside your repository build folder )

If you want to build your own docs with Antora see this guide