Skip to content
Snippets Groups Projects

OpenHarmony Documentation Repository

Documentation Status

This repository provides the overarching documentation of the OpenHarmony project. It does that by aggregating multiple sphinx projects part of OpenHarmony ecosystem and consolidating all these documentation trees as part of one, project-wide, sphinx project.

Building the docs

As per the current implementation for satisfying aggregation of multiple sphinx projects, the repository takes advantage of symlinks which assume a workspace set up from the manifest repository. Once that is initialized and synced, one can build/validate the documentation by simply running:

make

Contributing

See the CONTRIBUTING.md file.

License

The license of this repository is as follows:

  • Documentation text is under CC-BY-4.0 license
  • Scripts, tools, and so on, are under Apache-2.0 license

See the LICENSES subdirectory for full license texts.