[Python-modules-commits] r8104 - in packages/sphinx/trunk/debian (3 files)

[jandd-guest at users.alioth.debian.org]

    Date: Saturday, March 28, 2009 @ 21:30:33
  Author: jandd-guest
Revision: 8104

add sphinx-autogen man page

Added:
  packages/sphinx/trunk/debian/sphinx-autogen.1
Modified:
  packages/sphinx/trunk/debian/changelog
  packages/sphinx/trunk/debian/manpages

Modified: packages/sphinx/trunk/debian/changelog
===================================================================
--- packages/sphinx/trunk/debian/changelog	2009-03-28 19:31:28 UTC (rev 8103)
+++ packages/sphinx/trunk/debian/changelog	2009-03-28 21:30:33 UTC (rev 8104)
@@ -7,8 +7,11 @@
   * Build depend on python-all (>= 2.5.4-1) (py_libdir is now used in
     debian/rules)
   TODO:
-  * create manpage for sphinx-autogen
+  * add working sphinx-autogen script
 
+  [ Jan Dittberner ]
+  * add man page debian/sphinx-autogen.1
+
  -- Debian Python Modules Team <python-modules-team at lists.alioth.debian.org>  Thu, 26 Mar 2009 20:04:41 +0100
 
 sphinx (0.5.2-1) unstable; urgency=low

Modified: packages/sphinx/trunk/debian/manpages
===================================================================
--- packages/sphinx/trunk/debian/manpages	2009-03-28 19:31:28 UTC (rev 8103)
+++ packages/sphinx/trunk/debian/manpages	2009-03-28 21:30:33 UTC (rev 8104)
@@ -1,2 +1,3 @@
 debian/sphinx-build.1
 debian/sphinx-quickstart.1
+debian/sphinx-autogen.1

Added: packages/sphinx/trunk/debian/sphinx-autogen.1
===================================================================
--- packages/sphinx/trunk/debian/sphinx-autogen.1	                        (rev 0)
+++ packages/sphinx/trunk/debian/sphinx-autogen.1	2009-03-28 21:30:33 UTC (rev 8104)
@@ -0,0 +1,41 @@
+.TH sphinx\-autogen 1 "Sat, 28 Mar 2009" "Jan Dittberner" "User Commands"
+
+.SH NAME
+sphinx\-autogen \- generate ReStructuredText using \fBautosummary\fR
+directives
+
+.SH SYNOPSIS
+.B sphinx\-autogen
+[\fI\-o output_dir\fR]
+[\fI\-s suffix\fR]
+.BI sourcefile ...
+
+.SH OPTIONS
+.TP
+\fB\-o output_dir\fR
+the directory the output files should be written to
+.TP
+\fB\-s suffix\fR
+the suffix of the written files (defaults to rst)
+
+.SH DESCRIPTION
+.B sphinx\-autogen
+is a frontend to the \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
+\fBsphinx.ext.autosummary\fR Python module and can be read using
+
+.B pydoc
+.I sphinx.ext.autosummary
+
+.SH SEE ALSO
+.BR sphinx\-quickstart (1),
+.BR sphinx\-build (1)
+
+.BR http://sphinx.pocoo.org/ The sphinx website
+
+.SH AUTHOR
+This man page was written by Jan Dittberner <jan at dittberner.info> for
+the Debian GNU/Linux System (but may be used by others).