README.md 1.17 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<!--
SPDX-FileCopyrightText: Huawei Inc.

SPDX-License-Identifier: CC-BY-4.0
-->

# OpenHarmony Documentation Repository

[![Documentation Status](https://readthedocs.org/projects/openharmony/badge/?version=latest)](https://openharmony.readthedocs.io/en/latest/?badge=latest)

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](https://git.ostc-eu.org/OSTC/OHOS/manifest/).
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.