Skip to content
Snippets Groups Projects
Verified Commit ecc62a03 authored by Andrei Gherzan's avatar Andrei Gherzan :penguin:
Browse files

docs: Wrap building the docs in make


Signed-off-by: Andrei Gherzan's avatarAndrei Gherzan <andrei.gherzan@huawei.com>
parent e54a2cfb
No related branches found
No related tags found
No related merge requests found
# SPDX-FileCopyrightText: Huawei Inc.
#
# SPDX-License-Identifier: Apache-2.0
.PHONY: all
all:
sphinx-build -W -C \
-D html_theme=sphinx_rtd_theme \
-D project='OpenHarmony Build System and meta-ohos' \
-D copyright='Huawei Inc' \
. build
clean:
rm -rf ./build
......@@ -6,12 +6,16 @@ SPDX-License-Identifier: CC-BY-4.0
# Documentation for meta-ohos
The documentation for `meta-ohos` is written as reST files and can be generated with `sphinx-build` tool:
The documentation for `meta-ohos` is written as reST files and can be generated
by using standard make targets:
```
sphinx-build -C -D html_theme=sphinx_rtd_theme -D project='OpenHarmony Build System and meta-ohos' -D copyright='Huawei Inc' . build
make
make clean
```
Building the documentation requires `sphinx-build` to be available on the host.
# License
All the documentation is licensed as `CC-BY-4.0`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment