[Python-modules-commits] r18915 - in packages/sphinx/branches/1.1/debian (6 files)
jwilk at users.alioth.debian.org
jwilk at users.alioth.debian.org
Fri Oct 14 21:56:35 UTC 2011
Date: Friday, October 14, 2011 @ 21:56:34
Author: jwilk
Revision: 18915
Build manual pages (except for sphinx-autogen) from upstream sources. Merge changes that were made for Debian into them.
Added:
packages/sphinx/branches/1.1/debian/patches/merge_debian_manpages.diff
Modified:
packages/sphinx/branches/1.1/debian/changelog
packages/sphinx/branches/1.1/debian/patches/series
packages/sphinx/branches/1.1/debian/python-sphinx.manpages
Deleted:
packages/sphinx/branches/1.1/debian/sphinx-build.1
packages/sphinx/branches/1.1/debian/sphinx-quickstart.1
Modified: packages/sphinx/branches/1.1/debian/changelog
===================================================================
--- packages/sphinx/branches/1.1/debian/changelog 2011-10-14 19:57:07 UTC (rev 18914)
+++ packages/sphinx/branches/1.1/debian/changelog 2011-10-14 21:56:34 UTC (rev 18915)
@@ -20,10 +20,11 @@
* Refactor the code responsible for moving data into a private directory.
Rename some variables to make them lowercase. Don't use CURDIR where it's
not necessary.
- * Build and install sphinx-apidoc manpage.
+ * Build manual pages (except for sphinx-autogen) from upstream sources.
+ Merge changes that were made for Debian into them.
* Run nosetests with --verbose --no-skip.
- -- Jakub Wilk <jwilk at debian.org> Fri, 14 Oct 2011 21:54:36 +0200
+ -- Jakub Wilk <jwilk at debian.org> Fri, 14 Oct 2011 23:52:00 +0200
sphinx (1.0.8+dfsg-2) unstable; urgency=low
Added: packages/sphinx/branches/1.1/debian/patches/merge_debian_manpages.diff
===================================================================
--- packages/sphinx/branches/1.1/debian/patches/merge_debian_manpages.diff (rev 0)
+++ packages/sphinx/branches/1.1/debian/patches/merge_debian_manpages.diff 2011-10-14 21:56:34 UTC (rev 18915)
@@ -0,0 +1,169 @@
+Description: Merge changes to Debian manpges into upstream manpages.
+Author: Jakub Wilk <jwilk at debian.org>
+Forwarded: no
+Last-Update: 2011-10-14
+
+--- sphinx-1.1+dfsg.orig/doc/man/sphinx-quickstart.rst
++++ sphinx-1.1+dfsg/doc/man/sphinx-quickstart.rst
+@@ -12,9 +12,10 @@ Synopsis
+ Description
+ -----------
+
+-:program:`sphinx-quickstart` is an interactive tool that asks some questions
++:program:`sphinx-quickstart` is the interactive tool that asks some questions
+ about your project and then generates a complete documentation directory and
+ sample Makefile to be used with :manpage:`sphinx-build(1)`.
++.. XXX ^^^ The Debian manpage had s/a complete/a template/.
+
+
+ See also
+--- sphinx-1.1+dfsg.orig/doc/man/sphinx-build.rst
++++ sphinx-1.1+dfsg/doc/man/sphinx-build.rst
+@@ -13,83 +13,104 @@ Description
+ -----------
+
+ :program:`sphinx-build` generates documentation from the files in
+-``<sourcedir>`` and places it in the ``<outdir>``.
++:file:`<sourcedir>` and places it to the :file:`<outdir>`.
+
+-:program:`sphinx-build` looks for ``<sourcedir>/conf.py`` for the configuration
++:program:`sphinx-build` reads :file:`<sourcedir>/conf.py` for the configuration
+ settings. :manpage:`sphinx-quickstart(1)` may be used to generate template
+-files, including ``conf.py``.
++files, including :file:`conf.py`.
+
+-:program:`sphinx-build` can create documentation in different formats. A format
+-is selected by specifying the builder name on the command line; it defaults to
+-HTML. Builders can also perform other tasks related to documentation
+-processing.
++:program:`sphinx-build` can create documentation in different formats. The
++output format is selected by specifying the builder name on the command line;
++it defaults to HTML. Builders can also perform other tasks related to
++documentation processing.
+
+ By default, everything that is outdated is built. Output only for selected
+ files can be built by specifying individual filenames.
++.. XXX ^^^ The Debian manpage didn't have this paragraph. It probably
++.. needs rephrasing.
+
+ List of available builders:
+
+ html
+- HTML file generation. This is the default builder.
++ Build HTML pages. This is the default builder.
+
+-htmlhelp
+- Generates files for CHM (compiled help files) generation.
++singlehtml
++ Build a single HTML with the whole content.
+
+-qthelp
+- Generates files for Qt help collection generation.
++dirhtml
++ Build HTML pages, but with a single directory per document.
+
+-devhelp
+- Generates files for the GNOME Devhelp help viewer.
++htmlhelp, qthelp, devhelp, epub
++ Build HTML pages with additional information for building a documentation
++ collection in one of these formats.
+
+ latex
+- Generates LaTeX output that can be compiled to a PDF document.
++ Build LaTeX sources that can be compiled to a PDF document using
++ :program:`pdflatex`. This builder uses the :envvar:`PAPER` environment
++ variable (e.g. :samp:`PAPER=a4` or :samp:`PAPER=letter`) if available.
+
+ man
+- Generates manual pages.
++ Build manual pages in groff format for UNIX systems.
+
+ texinfo
+- Generates Texinfo output that can be processed by :program:`makeinfo` to
++ Build Texinfo output that can be processed by :program:`makeinfo` to
+ generate an Info document.
+
+ text
+- Generates a plain-text version of the documentation.
++ Build plain text files.
+
+ changes
+- Generates HTML files listing changed/added/deprecated items for
+- the current version of the documented project.
++ Generate HTML files listing changed/added/deprecated items for the current
++ version of the documented project.
+
+ linkcheck
+- Checks the integrity of all external links in the source.
++ Check the integrity of all external links in the source.
+
+-pickle / json
+- Generates serialized HTML files for use in web applications.
++pickle, json
++ Produce a directory with pickle/JSON files containing mostly HTML fragments
++ and TOC information, for use of a web application (or a custom
++ postprocessing tool) that doesn't use the standard HTML templates.
+
+
+ Options
+ -------
+
+--b <builder> Builder to use; defaults to html. See the full list
+- of builders above.
+--a Generate output for all files; without this option only
+- output for new and changed files is generated.
+--E Ignore cached files, forces to re-read all source files
+- from disk.
+--c <path> Locate the conf.py file in the specified path instead of
+- <sourcedir>.
+--C Specify that no conf.py file at all is to be used.
+- Configuration can only be set with the -D option.
+--D <setting=value> Override a setting from the configuration file.
+--d <path> Path to cached files; defaults to <outdir>/.doctrees.
+--A <name=value> Pass a value into the HTML templates (only for HTML builders).
++-b <builder> Select a builder. The default is ``html``. See the full
++ list of builders above.
++-a Write all output files. (The default is to only write
++ output files for new and changed source files.)
++-E 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.)
++-t <tag> Define the `tag`. This is relevant for :rst:dir:`only`
++ directives that only include their content if this tag is
++ set.
++-c <path> Don't look for the :file:`conf.py` in the
++ :file:`<sourcedir>`, but use the given configuration
++ directory instead. Various other files and paths given by
++ configuration values are expected to be relative to the
++ configuration directory, so they will have to be present
++ at this location too.
++-C Don't look for a configuration file; only take options
++ via the -D option.
++-D <setting=value> Override a configuration value set in the configuation file.
++-d <path> Select cache directory. The default is
++ :file:`<outdir>/.doctrees/`.
++-A <name=value> Make the `name` assigned to `value` in the HTML templates
++ (only for HTML builders).
+ -n Run in nit-picky mode, warn about all missing references.
+--N Prevent colored output.
+--q Quiet operation, just print warnings and errors on stderr.
+--Q Very quiet operation, don't print anything except for errors.
+--w <file> Write warnings and errors into the given file, in addition
+- to stderr.
++-N Do not emit colored output.
++-q Do not output anything on standard output, only write
++ warnings and errors to standard error.
++-Q Do not output anything on standard output, also suppress
++ warnings. Only errors are written to standard error.
++-w <file> Turn warnings into errors. This means that the build
++ stops at the first warning and :program:`sphinx-build`
++ exits with exit status 1.
+ -W Turn warnings into errors.
+--P Run Pdb on exception.
+-
++-P Run the Python debugger, :manpage:`pdb(1)`, if an
++ unhandled exception occurs while building.
+
+ See also
+ --------
Modified: packages/sphinx/branches/1.1/debian/patches/series
===================================================================
--- packages/sphinx/branches/1.1/debian/patches/series 2011-10-14 19:57:07 UTC (rev 18914)
+++ packages/sphinx/branches/1.1/debian/patches/series 2011-10-14 21:56:34 UTC (rev 18915)
@@ -3,3 +3,4 @@
unversioned_grammar_pickle.diff
show_more_stack_frames.diff
sphinx-apidoc_script.diff
+merge_debian_manpages.diff
Modified: packages/sphinx/branches/1.1/debian/python-sphinx.manpages
===================================================================
--- packages/sphinx/branches/1.1/debian/python-sphinx.manpages 2011-10-14 19:57:07 UTC (rev 18914)
+++ packages/sphinx/branches/1.1/debian/python-sphinx.manpages 2011-10-14 21:56:34 UTC (rev 18915)
@@ -1,5 +1,5 @@
-debian/sphinx-build.1
-debian/sphinx-quickstart.1
+build/man/sphinx-build.1
+build/man/sphinx-quickstart.1
+build/man/sphinx-apidoc.1
debian/sphinx-autogen.1
-build/man/sphinx-apidoc.1
debian/dh-sphinxdoc/dh_sphinxdoc.1
Deleted: packages/sphinx/branches/1.1/debian/sphinx-build.1
===================================================================
--- packages/sphinx/branches/1.1/debian/sphinx-build.1 2011-10-14 19:57:07 UTC (rev 18914)
+++ packages/sphinx/branches/1.1/debian/sphinx-build.1 2011-10-14 21:56:34 UTC (rev 18915)
@@ -1,120 +0,0 @@
-.TH sphinx-build 1 "Aug 2010" "Sphinx 1.1" "User Commands"
-.SH NAME
-sphinx-build \- Sphinx documentation generator tool
-.SH SYNOPSIS
-.B sphinx-build
-[\fIoptions\fR] <\fIsourcedir\fR> <\fIoutdir\fR> [\fIfilenames\fR...]
-.SH DESCRIPTION
-\fBsphinx-build\fR generates documentation from the files in \fIsourcedir\fR and places it
-to the \fIoutdir\fR.
-
-\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.
-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
-\fBhtml\fR
-Build HTML pages. This is the default builder.
-.TP
-\fBsinglehtml\fR
-Build a single HTML with the whole content.
-.TP
-\fBdirhtml\fR
-Build HTML pages, but with a single directory per document.
-.TP
-\fBhtmlhelp\fR, \fBqthelp\fR, \fBdevhelp\fR, \fBepub\fR
-Build HTML pages with additional information for building a documentation collection in one of these formats.
-.TP
-\fBlatex\fR
-Build LaTeX sources that can be compiled to a PDF document using \fBpdflatex\fR.
-This builder uses the PAPER environment variable (e.g. PAPER=a4 or PAPER=letter) if available.
-.TP
-\fBman\fR
-Build manual pages in groff format for UNIX systems.
-.TP
-\fBtext\fR
-Build plain text files.
-.TP
-\fBchanges\fR
-Show changed/added/deprecated items since last documentation generation.
-.TP
-\fBlinkcheck\fR
-Check the integrity of all external links in documentation.
-.TP
-\fBpickle\fR, \fBjson\fR
-Produce a directory with pickle/JSON files containing mostly HTML fragments and TOC information, for use of a web application (or a custom postprocessing tool) that doesn't use the standard HTML templates.
-.SH OPTIONS
-.TP
-\fB-b\fR \fIbuilder\fR
-Select a builder. The default is \fBhtml\fR. See the full list of builders above.
-.TP
-\fIfilename\fR
-Only generate documentation from the source file specified.
-Additionally, this option forces regeneration.
-.TP
-\fB-a\fR
-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 (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.
-.TP
-\fB-d\fR \fIpath\fR
-Select cache directory. The default is \fIoutdir\fP/.doctrees/.
-.TP
-\fB-c\fR \fIpath\fR
-Don't look for the conf.py in the \fIsourcedir\fR, but use the given configuration directory instead. Various other files and paths given by configuration values are expected to be relative to the configuration directory, so they will have to be present at this location too.
-.TP
-\fB-C\fR
-Don't look for a configuration file; only take options via the \fB-D\fR option.
-.TP
-\fB-D\fR \fIsetting\fR=\fIvalue\fR
-Override a configuration value set in the \fBconf.py\fR file.
-.TP
-\fB-A\fR \fIname\fR=\fIvalue\fR
-Make the \fIname\fR assigned to \fIvalue\fR in the HTML templates.
-.TP
-\fB-N\fR
-Do not emit colored output
-.TP
-\fB-q\fR
-Do not output anything on standard output, only write warnings and errors to standard error.
-.TP
-\fB-Q\fR
-Do not output anything on standard output, also suppress warnings. Only errors are written to standard error.
-.TP
-\fB-w\fR \fIfile\fR
-Write warnings (and errors) to the given file, in addition to standard error.
-.TP
-\fB-W\fR
-Turn warnings into errors. This means that the build stops at the first warning and \fBsphinx-build\fR exits with exit status 1.
-.TP
-\fB-P\fR
-Run the Python debugger, \fBpdb\fR, if an unhandled exception occurs while building.
-.SH "SEE ALSO"
-\fBsphinx-quickstart\fR(1)
-.PP
-The full documentation for
-.B Sphinx
-is installed to
-.B /usr/share/doc/python-sphinx
-.
-.SH AUTHOR
-Georg Brandl <georg at python.org>, Armin Ronacher <armin.ronacher at active-4.com> et
-al.
-.PP
-This manual page was written by Mikhail Gusarov <dottedmag at dottedmag.net>, for
-the Debian project (but may be used by others).
Deleted: packages/sphinx/branches/1.1/debian/sphinx-quickstart.1
===================================================================
--- packages/sphinx/branches/1.1/debian/sphinx-quickstart.1 2011-10-14 19:57:07 UTC (rev 18914)
+++ packages/sphinx/branches/1.1/debian/sphinx-quickstart.1 2011-10-14 21:56:34 UTC (rev 18915)
@@ -1,23 +0,0 @@
-.TH sphinx-quickstart 1 "Aug 2010" "Sphinx 1.1" "User Commands"
-.SH NAME
-sphinx-quickstart \- Sphinx documentation template generator
-.SH SYNOPSIS
-.B sphinx-quickstart
-.SH DESCRIPTION
-sphinx-quickstart is the interactive tool which asks some questions about your
-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)
-.PP
-The full documentation for
-.B Sphinx
-is installed to
-.B /usr/share/doc/python-sphinx
-.
-.SH AUTHOR
-Georg Brandl <georg at python.org>, Armin Ronacher <armin.ronacher at active-4.com> et
-al.
-.PP
-This manual page was written by Mikhail Gusarov <dottedmag at dottedmag.net> for
-the Debian project (but may be used by others).
More information about the Python-modules-commits
mailing list