This repository has been archived by the owner on Apr 12, 2022. It is now read-only.

building documentation

Jump to bottom

Joseph Cayouette edited this page Aug 8, 2019 · 21 revisions

Building Documentation

Table of Contents

Building SUSE Manager Documentation
Building Uyuni Documetnation
Build All PDF Documents
Building Single PDF Documents
Building OBS Packages
- SUMA OBS Packages
- Uyuni OBS Packages
Publishing for SUSE.com
Publishing SUMA gh-pages
Publishing Uyuni gh-pages
Publishing API
- SUMA API
- Uyuni API

Assumptions

You have followed the steps to setup our toolchain
You have cloned the doc-susemanager repository

Building SUSE Manager Documentation

Procedure: Building SUMA Docs

From your local git checkout run the following command to see all available build options:
```
make help
```
To build the suma static HTML pages and PDF documents run:
```
make antora-suma
```

Building Uyuni Documetnation

Procedure: Building UYUNI Docs

From your local git checkout run the following command to see all available build options:
```
make help
```
To build the Uyuni static HTML pages and PDF documents run:
```
make antora-uyuni
```

Build All PDF Documents

Building Single PDF Documents

Building OBS Packages

SUMA OBS Packages

Uyuni OBS Packages

Publishing for SUSE.com

Publishing SUMA gh-pages

Publishing Uyuni gh-pages

Publishing API

SUMA API

Uyuni API