# 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 automation files for ansible, the CI environment for
the NWL and its documentation:

* doc
    - the documentation of the work for the NWL CI environment
* ansible automation:
    - ansible.cfg
        + the paths of inventory, collections, etc for AWX
    - inventory
        + the ansible inventory with all managed hosts/devices
    - playbooks
        + ansible playbooks
* jenkins environment:
    - jobs
        + Jenkinsfile_Common
            - a collection of commonly used functions, so that duplicated code
              can be avoided
        + Jenkinsfile_Build / Jenkinsfile_Build_awx
            - a pipeline building a NWL yocto target (postfix awx is for the
              instance set up with AWX)
        + Jenkinsfile_Documentation_awx
            - a pipeline building the CI documentation (for the instance set up
              with AWX)
    - docker
        + Dockerfile
        + nwl-cicd.yaml
        + plugins.txt
    - docker-compose.yaml


## 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 ..
```