README.md 1.59 KB
Newer Older
1
2
3
4
5
6
<!--
SPDX-FileCopyrightText: Huawei Inc.

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

Gururaj Shetty's avatar
Gururaj Shetty committed
7
# Oniro Project Documentation Repository
8

9
[![Documentation Status](https://readthedocs.org/projects/oniroproject/badge/?version=latest)](https://docs.oniroproject.org/en/latest/)
10

Gururaj Shetty's avatar
Gururaj Shetty committed
11
12
13
This repository provides the overarching documentation of the Oniro
Project. It does that by aggregating multiple `sphinx` projects part of
the Oniro Project ecosystem and consolidating all these documentation trees as part of
14
15
one, project-wide, `sphinx` project.

16
17
## Read The Docs

Gururaj Shetty's avatar
Gururaj Shetty committed
18
As part of the Oniro Project infrastructure, this documentation is pushed to a
19
Read The Docs project. You can inspect the `latest` version
Gururaj Shetty's avatar
Gururaj Shetty committed
20
21
[online](https://docs.oniroproject.org/en/latest/) or download it as
[PDF](https://docs.oniroproject.org/_/downloads/en/latest/pdf/).
22

23
24
25
26
## Building the docs

As per the current implementation for satisfying aggregation of multiple
`sphinx` projects, the repository takes advantage of symlinks which assume a
Gururaj Shetty's avatar
Gururaj Shetty committed
27
workspace set up from [the oniro repository](https://booting.oniroproject.org/distro/oniro/).
28
29
30
31
32
33
34
Once that is initialized and synced, one can build/validate the documentation
by simply running:

```
make
```

Gururaj Shetty's avatar
Gururaj Shetty committed
35
For the above command to succeed, ensure all the [prerequisites](https://docs.oniroproject.org/en/latest/building-project-documentation.html) are satisfied.
36

37
38
39
40
41
42
43
44
45
46
47
48
## 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.