sphinx-quickstart

Zusammenfassung

sphinx-quickstart

Beschreibung

sphinx-quickstart ist ein interaktives Werkzeug, das einige Fragen zu Ihrem Projekt stellt und dann ein vollständiges Dokumentationsverzeichnis und eine Beispiel-Makefile generiert, die mit sphinx-build(1) verwendet werden können.

Optionen

-q, --quiet

Leiser Modus, der den interaktiven Assistenten zur Angabe von Optionen überspringt. Diese Option erfordert die Optionen -p, -a und -v.

-h, --help, --version

Anzeige der Nutzungzusammenfassung oder der Sphinx-Version.

Strukturoptionen

--sep

Wenn angegeben, werden Quell- und Build-Verzeichnisse getrennt.

--no-sep

Wenn angegeben, wird das Build-Verzeichnis unter dem Quellverzeichnis erstellt.

--dot=DOT

Innerhalb des Stammverzeichnisses werden zwei weitere Verzeichnisse erstellt: „_templates“ für benutzerdefinierte HTML-Vorlagen und „_static“ für benutzerdefinierte Stylesheets und andere statische Dateien. Sie können ein anderes Präfix (z. B. „.“) eingeben, um den Unterstrich zu ersetzen.

Basisoptionen für das Projekt

-p PROJECT, --project=PROJECT

Der Projektname wird festgelegt. (siehe project).

-a AUTHOR, --author=AUTHOR

Autorennamen. (siehe copyright).

-v VERSION

Version des Projekts. (siehe version).

-r RELEASE, --release=RELEASE

Release des Projekts. (siehe release).

-l LANGUAGE, --language=LANGUAGE

Sprache des Dokuments. (siehe language).

--suffix=SUFFIX

Suffix der Quelldatei. (siehe source_suffix).

--master=MASTER

Name des Hauptdokuments. (siehe root_doc).

Erweiterungsoptionen

--ext-autodoc

Aktiviert die Erweiterung sphinx.ext.autodoc.

--ext-doctest

Aktiviert die Erweiterung sphinx.ext.doctest.

--ext-intersphinx

Aktiviert die Erweiterung sphinx.ext.intersphinx.

--ext-todo

Aktiviert die Erweiterung sphinx.ext.todo.

--ext-coverage

Aktiviert die Erweiterung sphinx.ext.coverage.

--ext-imgmath

Aktiviert die Erweiterung sphinx.ext.imgmath.

--ext-mathjax

Aktiviert die Erweiterung sphinx.ext.mathjax.

--ext-ifconfig

Aktiviert die Erweiterung sphinx.ext.ifconfig.

--ext-viewcode

Aktiviert die Erweiterung sphinx.ext.viewcode.

--ext-githubpages

Aktiviert die Erweiterung sphinx.ext.githubpages.

--extensions=EXTENSIONS

Aktiviert beliebige Erweiterungen.

Optionen für die Erstellung von Makefile und Batchfile

--use-make-mode (-m), --no-use-make-mode (-M)

Makefile/make.bat verwendet (oder verwendet nicht) den make-mode. Standard ist use, was ein prägnanteres Makefile/make.bat generiert.

Geändert in Version 1.5: make-mode ist Standard.

Geändert in Version 7.3: Die Unterstützung für die Deaktivierung des make-mode wird in Sphinx 8 entfernt.

Entfernt in Version 8.0: Die Option --no-use-make-mode. Die Option --use-make-mode hat nun keine Auswirkung mehr.

--makefile, --no-makefile

Erstellt (oder erstellt nicht) eine Makefile.

--batchfile, --no-batchfile

Erstellt (oder erstellt nicht) eine Batchdatei

Projektvorlagen

Hinzugefügt in Version 1.5: Projektvorlagenoptionen für sphinx-quickstart

-t, --templatedir=TEMPLATEDIR

Vorlagenverzeichnis für Vorlagendateien. Sie können die Vorlagen der von quickstart generierten Sphinx-Projektdokumente ändern. Folgende Jinja2-Vorlagendateien sind erlaubt:

  • root_doc.rst.jinja

  • conf.py.jinja

  • Makefile.jinja

  • Makefile.new.jinja

  • make.bat.jinja

  • make.bat.new.jinja

Im Detail verweisen Sie bitte auf die Systemvorlagendateien, die Sphinx bereitstellt. (sphinx/templates/quickstart)

-d NAME=VALUE

Definieren Sie eine Vorlagenvariable

Siehe auch

sphinx-build(1)