SDBS

General Purpose SSCCS Technical Documentation Build System

• A high-level orchestration layer for docs generation solutions (currently Quarto-driven).

Quick Start

With pip

pip install sdb
sdb init docs
sdb build docs --website

With Docker

docker pull ghcr.io/ssccsorg/sdbs:latest
docker run --rm -v $(pwd)/docs:/work -w /work ghcr.io/ssccsorg/sdbs:latest sdb build docs --website

Try the example project

git clone https://github.com/ssccsorg/sdbs.git
cd sdbs
./examples/build.sh quickstart

This installs SDBS from source (or uses Docker if Quarto is not available) and builds the examples/quickstart/ project — a minimal documentation site with a landing page, a getting-started guide, and an API reference.

CLI Reference

# Scaffold a new docs directory
sdb init docs
sdb init docs --template ssccs     # with SSCCS-specific templates

# Build all targets
sdb build .
sdb build . --website -j 4         # parallel website build

# Pre-render steps (latest docs, path resolution, formatting)
sdb pre docs

# Validate links and citations
sdb check .

# Remove Quarto build artifacts (_cached/, _files/, html, pdf...)
sdb clean docs

Development

Setup

git clone https://github.com/ssccsorg/sdbs.git
cd sdbs
pip install -e .

Run tests

python -m pytest tests/ -v

Build the Docker image

docker build -t ghcr.io/ssccsorg/sdbs:latest .

License

Apache 2.0