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 9, 2019 · 21 revisions

Building Documentation

Table of Contents

Building SUSE Manager Docs
Building Uyuni Docs
Building PDF Docs
- Building Single PDF Docs
  - Single SUMA PDF Docs
  - Single Uyuni PDF Docs
- Building All PDF Docs
  - All SUMA PDF Docs
  - All Uyuni PDF Docs
Building OBS Packages
- SUMA OBS Packages
- Uyuni OBS Packages
Publishing Documentation

Assumptions

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

Building SUSE Manager Docs

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 Docs

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

Building PDF Docs

Building Single PDF Docs

Single SUMA PDF Docs

Single Uyuni PDF Docs

Building All PDF Docs

All SUMA PDF Docs

All Uyuni PDF Docs

Building OBS Packages

SUMA OBS Packages

Uyuni OBS Packages

Publishing Documentation

Publishing for suse.com (Microfocus)

Publishing for documentation.suse.com (docserv)

Publishing to Github Pages (Develop Docs)

Publishing SUMA gh-pages

Publishing Uyuni gh-pages

Publishing API

SUMA API

Uyuni API