---
name: "taurusdoc"
section: "1"
platform: "linux"
package: "python-taurus"
version: "3.3.1+dfsg-1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/taurusdoc"
---

# taurusdoc(1)

manual page for taurusdoc 3.3.1

## NAME

taurusdoc - manual page for taurusdoc 3.3.1

## SYNOPSIS

**taurusdoc** \[*options*\]

## DESCRIPTION

a tool to help developers preview the documentation generated by their code

## OPTIONS

- **--version**

  show program's version number and exit

- **-h**, **--help**

  show this help message and exit

- **-v**, **--verbose**

  display a lot of information \[default\]

- **-q**, **--quiet**

  be really silent

- **--build-dir**=*BUILD\_DIR*

  build directory \[default=./build\]

- **-a**, **--all-files**

  generate from scratch \[default\]

- **--cache**

  use previously generated files

- **--format**=*BUILDER*

  output format \[default=html\]

- **--prefix**=*PREFIX*

  output directory

- **--class**=*KLASS*

  full class name to generate doc for (ex.: taurus.qt.qtgui.display.TaurusLabel

- **--package**=*PACKAGE*

  full package name to generate doc for (ex.: taurus.qt.qtgui.display)

- **--file**=*FILENAME*

  RST file