https://github.com/vorausrobotik/vdoc/actions/workflows/pipeline.yml/badge.svg https://img.shields.io/pypi/pyversions/vdoc https://img.shields.io/pypi/v/vdoc https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 https://img.shields.io/badge/code%20style-black-000000.svg

vdoc

Multi version documentation hosting.

Basic usage

Run vdoc with python

pip install vdoc
vdoc run

Run vdoc with docker

Warning

Make sure that you’re building the python package and the docker image locally before running this command. This can be removed as soon as vdoc is available on docker hub

docker run -p 8080:8080 -v ./vdoc-docs:/srv/vdoc/docs/ vdoc:latest

Building vdoc

# Prepare development environment
npm ci
python -m venv venv
source venv/bin/activate
pip install --upgrade pip tox

# Build UI
npm run build

# Build docs
tox run -e docs

# Build python package
tox run -e build

# Build local docker image
docker build -t vdoc:latest .

Configuration

vdoc can be configured via environment variables. Internally, it uses pydantic-settings for building the configuration. All configuration environment variables are prefixed with VDOC_:

Table 1 VDoc Configuration

Environment variable

Explanation

Default

VDOC_DOCS_DIR

The directory to which all project documentations will be uploaded to.

/srv/vdoc/docs/

Contents

License Compliance Information