Mailman 3 October 2008 - Python-checkins

r67024 - doctools/trunk/sphinx/directives/desc.py
by georg.brandl Oct. 25, 2008

Oct. 25, 2008

Author: georg.brandl Date: Sat Oct 25 18:47:14 2008 New Revision: 67024 Log: Respect add_module_names for index entries. Modified: doctools/trunk/sphinx/directives/desc.py Modified: doctools/trunk/sphinx/directives/desc.py ============================================================================== --- doctools/trunk/sphinx/directives/desc.py (original) +++ doctools/trunk/sphinx/directives/desc.py Sat Oct 25 18:47:14 2008 @@ -20,7 +20,7 @@ # ------ information units --------------------------------------------------------- -def desc_index_text(desctype, module, name): +def desc_index_text(desctype, module, name, add_modules): if desctype == 'function': if not module: return _('%s() (built-in function)') % name @@ -41,7 +41,7 @@ return _('%s() (in module %s)') % (name, module) else: return '%s()' % name - if module: + if module and add_modules: return _('%s() (%s.%s method)') % (methname, module, clsname) else: return _('%s() (%s method)') % (methname, clsname) @@ -53,7 +53,7 @@ return _('%s() (in module %s)') % (name, module) else: return '%s()' % name - if module: + if module and add_modules: return _('%s() (%s.%s static method)') % (methname, module, clsname) else: return _('%s() (%s static method)') % (methname, clsname) @@ -65,7 +65,7 @@ return _('%s (in module %s)') % (name, module) else: return name - if module: + if module and add_modules: return _('%s (%s.%s attribute)') % (attrname, module, clsname) else: return _('%s (%s attribute)') % (attrname, clsname) @@ -455,7 +455,8 @@ env.note_descref(fullname, desctype, lineno) names.append(name) - indextext = desc_index_text(desctype, module, name) + indextext = desc_index_text(desctype, module, name, + env.config.add_module_names) inode['entries'].append(('single', indextext, fullname, fullname)) subnode = addnodes.desc_content()

1 0

r67023 - in doctools/trunk: CHANGES sphinx/directives/desc.py
by georg.brandl Oct. 25, 2008

Oct. 25, 2008

Author: georg.brandl Date: Sat Oct 25 18:40:59 2008 New Revision: 67023 Log: Don't disregard return annotations for functions without any parameters. Modified: doctools/trunk/CHANGES doctools/trunk/sphinx/directives/desc.py Modified: doctools/trunk/CHANGES ============================================================================== --- doctools/trunk/CHANGES (original) +++ doctools/trunk/CHANGES Sat Oct 25 18:40:59 2008 @@ -140,6 +140,8 @@ * Fix a problem with index generation in LaTeX output, caused by hyperref not being included last. +* Don't disregard return annotations for functions without any parameters. + Release 0.4.3 (Oct 8, 2008) =========================== Modified: doctools/trunk/sphinx/directives/desc.py ============================================================================== --- doctools/trunk/sphinx/directives/desc.py (original) +++ doctools/trunk/sphinx/directives/desc.py Sat Oct 25 18:40:59 2008 @@ -199,6 +199,9 @@ raise ValueError classname, name, arglist, retann = m.groups() + if retann: + retann = u' \N{RIGHTWARDS ARROW} ' + retann.strip()[2:] + if env.currclass: add_module = False if classname and classname.startswith(env.currclass): @@ -233,6 +236,8 @@ if desctype in ('function', 'method', 'staticmethod'): # for callables, add an empty parameter list signode += addnodes.desc_parameterlist() + if retann: + signode += addnodes.desc_type(retann, retann) return fullname, classname signode += addnodes.desc_parameterlist() @@ -255,7 +260,6 @@ if len(stack) != 1: raise ValueError if retann: - retann = u' \N{RIGHTWARDS ARROW} ' + retann.strip()[2:] signode += addnodes.desc_type(retann, retann) return fullname, classname

1 0

buildbot failure in x86 OpenBSD 3.0
by buildbot＠python.org Oct. 25, 2008

Oct. 25, 2008

The Buildbot has detected a new failure of x86 OpenBSD 3.0. Full details are available at: http://www.python.org/dev/buildbot/all/x86%20OpenBSD%203.0/builds/364 Buildbot URL: http://www.python.org/dev/buildbot/all/ Buildslave for this Build: cortesi Build Reason: Build Source Stamp: [branch branches/py3k] HEAD Blamelist: benjamin.peterson BUILD FAILED: failed failed slave lost sincerely, -The Buildbot

1 0

buildbot failure in amd64 gentoo 3.0
by buildbot＠python.org Oct. 25, 2008

Oct. 25, 2008

The Buildbot has detected a new failure of amd64 gentoo 3.0. Full details are available at: http://www.python.org/dev/buildbot/all/amd64%20gentoo%203.0/builds/1225 Buildbot URL: http://www.python.org/dev/buildbot/all/ Buildslave for this Build: norwitz-amd64 Build Reason: Build Source Stamp: [branch branches/py3k] HEAD Blamelist: benjamin.peterson BUILD FAILED: failed test Excerpt from the test logfile: 1 test failed: test_smtplib make: *** [buildbottest] Error 1 sincerely, -The Buildbot

1 0

r67022 - in doctools/trunk: CHANGES sphinx/locale/es sphinx/locale/es/LC_MESSAGES sphinx/locale/es/LC_MESSAGES/sphinx.js sphinx/locale/es/LC_MESSAGES/sphinx.mo
by georg.brandl Oct. 25, 2008

Oct. 25, 2008

Author: georg.brandl Date: Sat Oct 25 18:10:21 2008 New Revision: 67022 Log: Add Spanish locale, by Guillem Borrell. Added: doctools/trunk/sphinx/locale/es/ doctools/trunk/sphinx/locale/es/LC_MESSAGES/ doctools/trunk/sphinx/locale/es/LC_MESSAGES/sphinx.js (contents, props changed) doctools/trunk/sphinx/locale/es/LC_MESSAGES/sphinx.mo (contents, props changed) Modified: doctools/trunk/CHANGES Modified: doctools/trunk/CHANGES ============================================================================== --- doctools/trunk/CHANGES (original) +++ doctools/trunk/CHANGES Sat Oct 25 18:10:21 2008 @@ -66,6 +66,7 @@ * David Larlet -- French * Michał Kandulski -- Polish * Yasushi Masuda -- Japanese + * Guillem Borrell -- Spanish - The new config value ``highlight_language`` set a global default for highlighting. When ``'python3'`` is selected, console output blocks Added: doctools/trunk/sphinx/locale/es/LC_MESSAGES/sphinx.js ============================================================================== --- (empty file) +++ doctools/trunk/sphinx/locale/es/LC_MESSAGES/sphinx.js Sat Oct 25 18:10:21 2008 @@ -0,0 +1 @@ +Documentation.addTranslations({"locale": "es", "plural_expr": "(n != 1)", "messages": {"Search Results": "Resultados de la b\u00fasqueda", "Preparing search...": "Preparando la b\u00fasqueda", "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.": "La b\u00fasqueda no dio ning\u00fan resultado. Por favor aseg\u00farese que escribi\u00f3 todas las palabras correctamente y que ha seleccionado suficientes categor\u00edas", "Search finished, found %s page(s) matching the search query.": "B\u00fasqueda finalizada, se han encontrado %s p\u00e1gina(s) que concuerdan con su consulta", "Permalink to this headline": "Enlazar permanentemente con este t\u00edtulo", "Searching": "Buscando", "Permalink to this definition": "Enlazar permanentemente con esta definici\u00f3n", "Hide Search Matches": "Coincidencias de la b\u00fasqueda"}}); \ No newline at end of file Added: doctools/trunk/sphinx/locale/es/LC_MESSAGES/sphinx.mo ============================================================================== Binary file. No diff available.

1 0

r67021 - doctools/trunk/sphinx/environment.py
by georg.brandl Oct. 25, 2008

Oct. 25, 2008

Author: georg.brandl Date: Sat Oct 25 18:09:15 2008 New Revision: 67021 Log: Fix outdated docstring. Modified: doctools/trunk/sphinx/environment.py Modified: doctools/trunk/sphinx/environment.py ============================================================================== --- doctools/trunk/sphinx/environment.py (original) +++ doctools/trunk/sphinx/environment.py Sat Oct 25 18:09:15 2008 @@ -128,7 +128,7 @@ class HandleCodeBlocks(Transform): """ - Move doctest blocks out of blockquotes and connect adjacent code blocks. + Move doctest blocks out of blockquotes. """ default_priority = 210

1 0

r67020 - in doctools/trunk/doc: markup/inline.rst rest.rst
by georg.brandl Oct. 25, 2008

Oct. 25, 2008

Author: georg.brandl Date: Sat Oct 25 18:00:53 2008 New Revision: 67020 Log: Add a note about substitutions. Modified: doctools/trunk/doc/markup/inline.rst doctools/trunk/doc/rest.rst Modified: doctools/trunk/doc/markup/inline.rst ============================================================================== --- doctools/trunk/doc/markup/inline.rst (original) +++ doctools/trunk/doc/markup/inline.rst Sat Oct 25 18:00:53 2008 @@ -350,6 +350,7 @@ Note that there are no special roles for including hyperlinks as you can use the standard reST markup for that purpose. +.. _default-substitutions: Substitutions ------------- Modified: doctools/trunk/doc/rest.rst ============================================================================== --- doctools/trunk/doc/rest.rst (original) +++ doctools/trunk/doc/rest.rst Sat Oct 25 18:00:53 2008 @@ -270,6 +270,28 @@ numeric or begins with ``#``. +Substitutions +------------- + +reST supports "substitutions", which are pieces of text and/or markup referred +to in the text by ``|name|``. They are defined like footnotes with explicit +markup blocks, like this:: + + .. |name| replace:: replacement *text* + +See the `reST reference for substitutions +<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitu…>`_ +for details. + +If you want to use some substitutions for all documents, put them into a +separate file and include it into all documents you want to use them in, using +the :dir:`include` directive. Be sure to give the include file a file name +extension differing from that of other source files, to avoid Sphinx finding it +as a standalone document. + +Sphinx defines some default substitutions, see :ref:`default-substitutions`. + + Comments --------

1 0

r67019 - in doctools/trunk: CHANGES doc/rest.rst sphinx/environment.py sphinx/texinputs/howto.cls sphinx/texinputs/manual.cls sphinx/texinputs/sphinx.sty sphinx/textwriter.py tests/root/contents.txt tests/root/markup.txt tests/test_build.py
by georg.brandl Oct. 25, 2008

Oct. 25, 2008

Author: georg.brandl Date: Sat Oct 25 17:54:34 2008 New Revision: 67019 Log: Add global citations. #1. Modified: doctools/trunk/CHANGES doctools/trunk/doc/rest.rst doctools/trunk/sphinx/environment.py doctools/trunk/sphinx/texinputs/howto.cls doctools/trunk/sphinx/texinputs/manual.cls doctools/trunk/sphinx/texinputs/sphinx.sty doctools/trunk/sphinx/textwriter.py doctools/trunk/tests/root/contents.txt doctools/trunk/tests/root/markup.txt doctools/trunk/tests/test_build.py Modified: doctools/trunk/CHANGES ============================================================================== --- doctools/trunk/CHANGES (original) +++ doctools/trunk/CHANGES Sat Oct 25 17:54:34 2008 @@ -4,6 +4,27 @@ New features added ------------------ +* Markup features: + + - Citations are now global: all citation defined in any file can be + referenced from any file. Citations are collected in a bibliography + for LaTeX output. + + - Footnotes are now properly handled in the LaTeX builder: they appear + at the location of the footnote reference in text, not at the end of + a section. Thanks to Andrew McNamara for the initial patch. + + - "System Message" warnings are now automatically removed from the + built documentation, and only written to stderr. If you want the + old behavior, set the new config value ``keep_warnings`` to True. + + - Glossary entries are now automatically added to the index. + + - Figures with captions can now be referred to like section titles, + using the ``:ref:`` role without an explicit link text. + + - Added ``cmember`` role for consistency. + * HTML output and templates: - Incompatible change: The "root" relation link (top left in the @@ -22,7 +43,7 @@ can be subclassed to serialize build HTML in a specific format. The ``PickleHTMLBuilder`` is a concrete subclass of it that uses pickle as serialization implementation. - + - ``JSONHTMLBuilder`` was added as another ``SerializingHTMLBuilder`` subclass that dumps the generated HTML into JSON files for further processing. @@ -35,7 +56,7 @@ definition links. * New and changed config values: - + - Added support for internationalization in generated text with the ``language`` and ``locale_dirs`` config values. Many thanks to language contributors: @@ -91,19 +112,6 @@ * Other changes: - - Footnotes are now properly handled in the LaTeX builder: they appear - at the location of the footnote reference in text, not at the end of - a section. Thanks to Andrew McNamara for the initial patch. - - - "System Message" warnings are now automatically removed from the - built documentation, and only written to stderr. If you want the - old behavior, set the new config value ``keep_warnings`` to True. - - - Glossary entries are now automatically added to the index. - - - Figures with captions can now be referred to like section titles, - using the ``:ref:`` role without an explicit link text. - - Added a distutils command `build_sphinx`: When Sphinx is installed, you can call ``python setup.py build_sphinx`` for projects that have Sphinx documentation, which will build the docs and place them in @@ -112,8 +120,6 @@ - In quickstart, if the selected root path already contains a Sphinx project, complain and abort. - - Added ``cmember`` role for consistency. - Bugs fixed ---------- Modified: doctools/trunk/doc/rest.rst ============================================================================== --- doctools/trunk/doc/rest.rst (original) +++ doctools/trunk/doc/rest.rst Sat Oct 25 17:54:34 2008 @@ -240,17 +240,34 @@ Footnotes --------- -For footnotes, use ``[#]_`` to mark the footnote location, and add the footnote -body at the bottom of the document after a "Footnotes" rubric heading, like so:: +For footnotes, use ``[#name]_`` to mark the footnote location, and add the +footnote body at the bottom of the document after a "Footnotes" rubric heading, +like so:: - Lorem ipsum [#]_ dolor sit amet ... [#]_ + Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_ .. rubric:: Footnotes - .. [#] Text of the first footnote. - .. [#] Text of the second footnote. + .. [#f1] Text of the first footnote. + .. [#f2] Text of the second footnote. -You can also explicitly number the footnotes for better context. +You can also explicitly number the footnotes (``[1]_``) or use auto-numbered +footnotes without names (``[#]_``). + + +Citations +--------- + +Standard reST citations are supported, with the additional feature that they are +"global", i.e. all citations can be referenced from all files. Use them like +so:: + + Lorem ipsum [Ref]_ dolor sit amet. + + .. [Ref] Book or article reference, URL or whatever. + +Citation usage is similar to footnote usage, but with a label that is not +numeric or begins with ``#``. Comments Modified: doctools/trunk/sphinx/environment.py ============================================================================== --- doctools/trunk/sphinx/environment.py (original) +++ doctools/trunk/sphinx/environment.py Sat Oct 25 17:54:34 2008 @@ -138,12 +138,27 @@ nodes.doctest_block): node.replace_self(node.children[0]) +class CitationReferences(Transform): + """ + Handle citation references before the default docutils transform does. + """ + default_priority = 619 + + def apply(self): + for citnode in self.document.traverse(nodes.citation_reference): + cittext = citnode.astext() + refnode = addnodes.pending_xref(cittext, reftype='citation', + reftarget=cittext) + refnode += nodes.Text('[' + cittext + ']') + citnode.parent.replace(citnode, refnode) + class SphinxStandaloneReader(standalone.Reader): """ Add our own transforms. """ - transforms = [DefaultSubstitutions, MoveModuleTargets, HandleCodeBlocks] + transforms = [CitationReferences, DefaultSubstitutions, MoveModuleTargets, + HandleCodeBlocks] def get_transforms(self): return standalone.Reader.get_transforms(self) + self.transforms @@ -259,7 +274,7 @@ self.labels = {} # labelname -> docname, labelid, sectionname self.anonlabels = {} # labelname -> docname, labelid self.reftargets = {} # (type, name) -> docname, labelid - # where type is term, token, option, envvar + # where type is term, token, option, envvar, citation # Other inventories self.indexentries = {} # docname -> list of @@ -530,6 +545,7 @@ self.create_title_from(docname, doctree) self.note_labels_from(docname, doctree) self.note_indexentries_from(docname, doctree) + self.note_citations_from(docname, doctree) self.build_toc_from(docname, doctree) # store time of reading, used to find outdated files @@ -714,6 +730,15 @@ for node in document.traverse(addnodes.index): entries.extend(node['entries']) + def note_citations_from(self, docname, document): + for node in document.traverse(nodes.citation): + label = node[0].astext() + if ('citation', label) in self.reftargets: + self.warn(docname, 'duplicate citation %s, ' % label + + 'other instance in %s' % self.doc2path( + self.reftargets['citation', label][0]), node.line) + self.reftargets['citation', label] = (docname, node['ids'][0]) + def note_toctree(self, docname, toctreenode): """Note a TOC tree directive in a document and gather information about file relations from it.""" @@ -943,7 +968,7 @@ 'meth', 'cfunc', 'cmember', 'cdata', 'ctype', 'cmacro')) def resolve_references(self, doctree, fromdocname, builder): - reftarget_roles = set(('token', 'term', 'option')) + reftarget_roles = set(('token', 'term', 'option', 'citation')) # add all custom xref types too reftarget_roles.update(i[0] for i in additional_xref_types.values()) @@ -1009,6 +1034,9 @@ if typ == 'term': self.warn(fromdocname, 'term not in glossary: %s' % target, node.line) + elif typ == 'citation': + self.warn(fromdocname, 'citation not found: %s' % target, + node.line) newnode = contnode else: newnode = nodes.reference('', '') Modified: doctools/trunk/sphinx/texinputs/howto.cls ============================================================================== --- doctools/trunk/sphinx/texinputs/howto.cls (original) +++ doctools/trunk/sphinx/texinputs/howto.cls Sat Oct 25 17:54:34 2008 @@ -58,18 +58,6 @@ \vspace{12pt} } -% Fix the theindex environment to add an entry to the Table of Contents; this is -% much nicer than just having to jump to the end of the book and flip around, -% especially with multiple indexes. -% -\let\py@OldTheindex=\theindex -\renewcommand{\theindex}{ - \clearpage - \phantomsection - \py@OldTheindex - \addcontentsline{toc}{section}{\indexname} -} - \@ifundefined{fancyhf}{ \pagestyle{plain}}{ \pagestyle{normal}} % start this way; change for Modified: doctools/trunk/sphinx/texinputs/manual.cls ============================================================================== --- doctools/trunk/sphinx/texinputs/manual.cls (original) +++ doctools/trunk/sphinx/texinputs/manual.cls Sat Oct 25 17:54:34 2008 @@ -101,15 +101,3 @@ % \renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}} \renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}} - -% Fix the theindex environment to add an entry to the Table of Contents; this is -% much nicer than just having to jump to the end of the book and flip around, -% especially with multiple indexes. -% -\let\py@OldTheindex=\theindex -\renewcommand{\theindex}{ - \cleardoublepage - \phantomsection - \py@OldTheindex - \addcontentsline{toc}{chapter}{\indexname} -} Modified: doctools/trunk/sphinx/texinputs/sphinx.sty ============================================================================== --- doctools/trunk/sphinx/texinputs/sphinx.sty (original) +++ doctools/trunk/sphinx/texinputs/sphinx.sty Sat Oct 25 17:54:34 2008 @@ -682,6 +682,26 @@ } +% Fix the index and bibliography environments to add an entry to the Table of +% Contents; this is much nicer than just having to jump to the end of the book +% and flip around, especially with multiple indexes. +% +\let\py@OldTheindex=\theindex +\renewcommand{\theindex}{ + \cleardoublepage + \phantomsection + \py@OldTheindex + \addcontentsline{toc}{chapter}{\indexname} +} + +\let\py@OldThebibliography=\thebibliography +\renewcommand{\thebibliography}[1]{ + \cleardoublepage + \phantomsection + \py@OldThebibliography{1} + \addcontentsline{toc}{chapter}{\bibname} +} + % Include hyperref last. \RequirePackage[colorlinks,breaklinks, linkcolor=InnerLinkColor,filecolor=OuterLinkColor, Modified: doctools/trunk/sphinx/textwriter.py ============================================================================== --- doctools/trunk/sphinx/textwriter.py (original) +++ doctools/trunk/sphinx/textwriter.py Sat Oct 25 17:54:34 2008 @@ -252,6 +252,15 @@ def depart_footnote(self, node): self.end_state(first='[%s] ' % self._footnote) + def visit_citation(self, node): + if len(node) and isinstance(node[0], nodes.label): + self._citlabel = node[0].astext() + else: + self._citlabel = '' + self.new_state(len(self._citlabel) + 3) + def depart_citation(self, node): + self.end_state(first='[%s] ' % self._citlabel) + def visit_label(self, node): raise nodes.SkipNode @@ -584,6 +593,10 @@ self.add_text('[%s]' % node.astext()) raise nodes.SkipNode + def visit_citation_reference(self, node): + self.add_text('[%s]' % node.astext()) + raise nodes.SkipNode + def visit_Text(self, node): self.add_text(node.astext()) def depart_Text(self, node): Modified: doctools/trunk/tests/root/contents.txt ============================================================================== --- doctools/trunk/tests/root/contents.txt (original) +++ doctools/trunk/tests/root/contents.txt Sat Oct 25 17:54:34 2008 @@ -23,3 +23,8 @@ * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +References +========== + +.. [Ref1] Reference target. Modified: doctools/trunk/tests/root/markup.txt ============================================================================== --- doctools/trunk/tests/root/markup.txt (original) +++ doctools/trunk/tests/root/markup.txt Sat Oct 25 17:54:34 2008 @@ -57,6 +57,8 @@ Stuff [#]_ +Reference lookup: [Ref1]_ (defined in another file). + .. seealso:: `Google <http://www.google.com>`_ Modified: doctools/trunk/tests/test_build.py ============================================================================== --- doctools/trunk/tests/test_build.py (original) +++ doctools/trunk/tests/test_build.py Sat Oct 25 17:54:34 2008 @@ -57,12 +57,16 @@ 'markup.html': { ".//meta[@name='author'][@content='Me']": '', ".//meta[@name='keywords'][@content='docs, sphinx']": '', + ".//a[@href='contents.html#ref1']": '', }, 'desc.html': { ".//dt[@id='mod.Cls.meth1']": '', ".//dt[@id='errmod.Error']": '', ".//a[@href='#mod.Cls']": '', }, + 'contents.html': { + ".//td[@class='label']": '[Ref1]', + }, } class NslessParser(ET.XMLParser):

1 0

r67017 - doctools/trunk/sphinx/static/default.css
by georg.brandl Oct. 25, 2008

Oct. 25, 2008

Author: georg.brandl Date: Sat Oct 25 17:37:40 2008 New Revision: 67017 Log: Remove explicit height for relbar, to allow breaking text not to flow into the main body. Modified: doctools/trunk/sphinx/static/default.css Modified: doctools/trunk/sphinx/static/default.css ============================================================================== --- doctools/trunk/sphinx/static/default.css (original) +++ doctools/trunk/sphinx/static/default.css Sat Oct 25 17:37:40 2008 @@ -63,7 +63,6 @@ background-color: #133f52; color: #fff; width: 100%; - height: 30px; line-height: 30px; font-size: 90%; }

1 0

r67016 - doctools/trunk/doc/config.rst
by georg.brandl Oct. 25, 2008

Oct. 25, 2008

Author: georg.brandl Date: Sat Oct 25 17:34:12 2008 New Revision: 67016 Log: Fix typo. Modified: doctools/trunk/doc/config.rst Modified: doctools/trunk/doc/config.rst ============================================================================== --- doctools/trunk/doc/config.rst (original) +++ doctools/trunk/doc/config.rst Sat Oct 25 17:34:12 2008 @@ -10,7 +10,7 @@ This file (containing Python code) is called the "build configuration file" and contains all configuration needed to customize Sphinx input and output behavior. -The configuration file if executed as Python code at build time (using +The configuration file is executed as Python code at build time (using :func:`execfile`, and with the current directory set to its containing directory), and therefore can execute arbitrarily complex code. Sphinx then reads simple names from the file's namespace as its configuration.

1 0