TOSA Specification Repository

This repository contains the source files for the TOSA specification. See the specification itself for details on the purpose and definition of the specification.

Build requirements

The TOSA specification is written in asciidoc format, and has been built using the following tools:

• Asciidoctor 1.5.5 or later (Asciidoctor)
• Asciidoctor-pdf
• GNU Make 4.1 or later
• xmllint
• Python 3.8 or later

The default make build creates both an html and a pdf version of the specification in out/html and out/pdf

If only an html build is required, make html will build only the html file, and asciidoctor-pdf is not needed.

If only a pdf build is required, make pdf will build only the pdf.

Pre Commit Checks

Before pushing a commit, pre commit checks must be run to ensure conformity.

Prerequisites

• pre-commit (tested with 3.8.0)

Install with:

pip install pre-commit==3.8.0

Run Pre Commit Checks

pre-commit run --all