[Python-modules-commits] r14310 - in packages/sphinx/trunk/debian (4 files)
stefanor-guest at users.alioth.debian.org
stefanor-guest at users.alioth.debian.org
Mon Aug 30 19:49:35 UTC 2010
Date: Monday, August 30, 2010 @ 19:49:32
Author: stefanor-guest
Revision: 14310
Improve language and clarify options in manpages.
Modified:
packages/sphinx/trunk/debian/changelog
packages/sphinx/trunk/debian/sphinx-autogen.1
packages/sphinx/trunk/debian/sphinx-build.1
packages/sphinx/trunk/debian/sphinx-quickstart.1
Modified: packages/sphinx/trunk/debian/changelog
===================================================================
--- packages/sphinx/trunk/debian/changelog 2010-08-30 16:13:39 UTC (rev 14309)
+++ packages/sphinx/trunk/debian/changelog 2010-08-30 19:49:32 UTC (rev 14310)
@@ -1,3 +1,9 @@
+sphinx (0.6.6-4) UNRELEASED; urgency=low
+
+ * Improve language and clarify options in manpages.
+
+ -- Stefano Rivera <stefano at rivera.za.net> Mon, 30 Aug 2010 21:48:10 +0200
+
sphinx (0.6.6-3) unstable; urgency=low
* Add myself to uploaders.
Modified: packages/sphinx/trunk/debian/sphinx-autogen.1
===================================================================
--- packages/sphinx/trunk/debian/sphinx-autogen.1 2010-08-30 16:13:39 UTC (rev 14309)
+++ packages/sphinx/trunk/debian/sphinx-autogen.1 2010-08-30 19:49:32 UTC (rev 14310)
@@ -20,8 +20,8 @@
.SH DESCRIPTION
.B sphinx\-autogen
-is a frontend to the \fBsphinx.ext.autosummary.generate\fR it
-generates the ReStructuredText files from the \fBautosummary\fR
+is a frontend to \fBsphinx.ext.autosummary.generate\fR.
+It generates the ReStructuredText files from the \fBautosummary\fR
directives contained in the given input files.
The format of the \fBautosummary\fR directive is documented in the
Modified: packages/sphinx/trunk/debian/sphinx-build.1
===================================================================
--- packages/sphinx/trunk/debian/sphinx-build.1 2010-08-30 16:13:39 UTC (rev 14309)
+++ packages/sphinx/trunk/debian/sphinx-build.1 2010-08-30 19:49:32 UTC (rev 14310)
@@ -8,13 +8,15 @@
\fBsphinx-build\fR generates documentation from the files in \fIsourcedir\fR and places it
to the \fIoutdir\fR.
-\fBsphinx-build\fR looks for \fIsourcedir\fR/conf.py for the configuration settings.
+\fBsphinx-build\fR reads \fIsourcedir\fR/conf.py for the configuration settings.
\fBsphinx-quickstart\fR(1)
may be used to generate template files, including conf.py.
-\fBsphinx-build\fR can create documentation in different formats. Format is selected
-by specifying builder in command line and defaults to HTML. Builders can
-also perform other tasks related to the documentation processing.
+\fBsphinx-build\fR can create documentation in different formats.
+The output format is selected by specifying builder in command line and
+defaults to HTML.
+Builders can also perform other tasks related to the documentation
+processing.
List of available builders:
.TP
@@ -48,15 +50,18 @@
Select a builder. The default is \fBhtml\fR. See the full list of builders above.
.TP
\fIfilename\fR
-Force to generate documentation for the file.
+Only generate documentation from the source file specified.
+Additionally, this option forces regeneration.
.TP
\fB-a\fR
-Always write all output files.
+Write all output files.
(The default is to only write output files for new and changed source files.)
.TP
\fB-E\fR
-Don't use a saved environment, but rebuild it completely.
-(The default is to only read and parse source files that are new or have changed since the last run.)
+Don't use a saved environment (the structure caching all
+cross-references), but rebuild completely.
+(The default is to only read and parse source files that are new or have
+changed since the last run.)
.TP
\fB-t\fR \fItag\fR
Define the \fItag\fR. This is relevant for \[oq]only\[cq] directives that only include their content if this tag is set.
Modified: packages/sphinx/trunk/debian/sphinx-quickstart.1
===================================================================
--- packages/sphinx/trunk/debian/sphinx-quickstart.1 2010-08-30 16:13:39 UTC (rev 14309)
+++ packages/sphinx/trunk/debian/sphinx-quickstart.1 2010-08-30 19:49:32 UTC (rev 14310)
@@ -5,7 +5,7 @@
.B sphinx-quickstart
.SH DESCRIPTION
sphinx-quickstart is the interactive tool which asks some questions about your
-Python project and then generates template documentation directory and sample
+Python project and then generates a template documentation directory and sample
Makefile to be used with \fBsphinx-build\fR(1).
.SH "SEE ALSO"
\fBsphinx-build\fR(1)
More information about the Python-modules-commits
mailing list