Building OpenHarmony documentation

This topic outlines the standard way of generating the OpenHarmony project documentation locally using the source files available in the git.ostc-eu.org repository which aggregates documentation from multiple other components.

Overview

The OpenHarmony documentation is written in reStructuredText markup language (.rst file extension) with Sphinx extensions to generate a structured stand-alone website.

To generate the HTML documentation locally, Sphinx must be installed on your local system. Also, to build the documentation using the provided Makefile, make must also be available on your host.

For more details on Sphinx installation, refer Sphinx Getting Started.

Building the documentation

To generate a local copy of OpenHarmony documentation, perform the following steps:

  1. Create a local workspace and clone the OpenHarmony project files to your local, refer to setting up a repo workspace section for more information.

  2. To generate output as HTML, run the following command:

$ make

The HTML output is built and can be viewed in your browser from the <docs repository>/build/index.html path.

Note

  • All the local Sphinx warnings and errors generated during the build process must be fixed and validated.

  • To validate the changes, execute make clean && make command to generate a clean HTML output.