Something went wrong on our end
-
Zygmunt Krynicki authored
Most things are moved unchanged. The relatively few changes are to the documentation, as the split between the meta-ohos and manifest is gone, as well as to the actual CI definitions for the workspace directory, since the sources/ sub-directory is gone, and there was some backwards-compatibility code that no longer makes sense to maintain. Signed-off-by:Zygmunt Krynicki <zygmunt.krynicki@huawei.com>
Zygmunt Krynicki authoredMost things are moved unchanged. The relatively few changes are to the documentation, as the split between the meta-ohos and manifest is gone, as well as to the actual CI definitions for the workspace directory, since the sources/ sub-directory is gone, and there was some backwards-compatibility code that no longer makes sense to maintain. Signed-off-by:
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
build-docs.rst 1.38 KiB
.build-docs
The .build-docs job builds reStructuredText documentation.
This job offers no configuration and works by convention. This is done to both
simplify its use and improve uniformity of developer experience. The job
automatically reacts to changes in the docs/ directory as well as the
definition of the pipeline. Built documentation is collected as job artifacts.
Usage Guide
To use this job in your pipeline include the generic build definition file,
build-generic.yaml and define a build-docs job:
build-docs:
extends: .build-docsThe job expects the project to have the following documentation structure.
└── docs
├── index.rst
└── MakefileThe Makefile should build the documentation into the build directory,
relative to the docs directory. A sample, re-usable example is is provided below:
# 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='Name of the project' \
-D copyright='Copyright Holder' \
. build
clean:
rm -rf ./build