Source

sphinx / doc / sphinx-quickstart.1

.TH sphinx-quickstart 1 "Jan 2009" "Sphinx 0.6" "User Commands"
.SH NAME
sphinx-quickstart \- Sphinx documentation template generator
.SH SYNOPSIS
.B sphinx-quickstart
.SH DESCRIPTION
sphinx-quickstart is an interactive tool that asks some questions about your
project and then generates a complete documentation directory and sample
Makefile to be used with \fBsphinx-build(1)\fR.
.SH "SEE ALSO"
.BR sphinx-build(1)
.SH AUTHOR
Georg Brandl <georg@python.org>, Armin Ronacher <armin.ronacher@active-4.com> et
al.
.PP
This manual page was initially written by Mikhail Gusarov
<dottedmag@dottedmag.net> for the Debian project.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.