54 lines
1.1 KiB
Markdown
54 lines
1.1 KiB
Markdown
# NetModule Wireless Linux CI/CD Repository
|
|
This repository contains all necessary jobs for the CI/CD environment of the
|
|
NetModule Wireless Linux (NWL).
|
|
|
|
|
|
## Content
|
|
This repository holds the documentation for the CI environment and the jobs for
|
|
the NWL as declarative pipelines (multibranch):
|
|
|
|
* doc
|
|
|
|
- the documentation of the work for the NWL CI environment
|
|
|
|
* jobs
|
|
|
|
- Jenkinsfile_Build
|
|
|
|
+ a pipeline building a NWL yocto target
|
|
|
|
- Jenkinsfile_Common
|
|
|
|
+ a collection of commonly used functions, so that duplicated code can be
|
|
avoided
|
|
|
|
|
|
## Marginal Notes
|
|
This repository does NOT cover the setup of the Jenkins instance.
|
|
|
|
|
|
## Building the Documentation
|
|
The documentation bases on sphinx and is written in reStructuredText format. To
|
|
build the documenation you need to install sphinx first:
|
|
|
|
```bash
|
|
sudo apt install python3-sphinx
|
|
sudo pip3 install cloud-sptheme
|
|
```
|
|
|
|
Within the directory ``doc`` you can use make as follows:
|
|
|
|
```bash
|
|
# entering doc:
|
|
cd doc
|
|
|
|
# clean and build the documentation:
|
|
make clean
|
|
make html
|
|
|
|
# open the generated documentation in the browser:
|
|
xdg-open out/html/index.html
|
|
|
|
cd ..
|
|
```
|