diff --git a/sphinx/themes/basic/static/searchtools.js_t b/sphinx/themes/basic/static/searchtools.js_t
index f96953b44..58e242828 100644
--- a/sphinx/themes/basic/static/searchtools.js_t
+++ b/sphinx/themes/basic/static/searchtools.js_t
@@ -64,8 +64,13 @@ var Search = {
},
loadIndex : function(url) {
- $.ajax({type: "GET", url: url, data: null, success: null,
- dataType: "script", cache: true});
+ $.ajax({type: "GET", url: url, data: null,
+ dataType: "script", cache: true,
+ complete: function(jqxhr, textstatus) {
+ if (textstatus != "success") {
+ document.getElementById("searchindexloader").src = url;
+ }
+ }});
},
setIndex : function(index) {
@@ -250,16 +255,18 @@ var Search = {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
- $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' +
- item[0] + '.txt', function(data) {
- if (data !== '') {
- listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
- Search.output.append(listItem);
- }
- listItem.slideDown(5, function() {
- displayNextItem();
- });
- }, "text");
+ $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt',
+ dataType: "text",
+ complete: function(jqxhr, textstatus) {
+ var data = jqxhr.responseText;
+ if (data !== '') {
+ listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
+ }
+ Search.output.append(listItem);
+ listItem.slideDown(5, function() {
+ displayNextItem();
+ });
+ }});
} else {
// no source available, just display title
Search.output.append(listItem);
diff --git a/sphinx/themes/haiku/layout.html b/sphinx/themes/haiku/layout.html
index edbda50b2..337d0ca24 100644
--- a/sphinx/themes/haiku/layout.html
+++ b/sphinx/themes/haiku/layout.html
@@ -56,7 +56,7 @@
{#{%- if display_toc %}
-
Table Of Contents
+ {{ _('Table Of Contents') }}
{{ toc }}
{%- endif %}#}
diff --git a/sphinx/themes/pyramid/static/epub.css b/sphinx/themes/pyramid/static/epub.css
index 28dff738b..cb2df575c 100644
--- a/sphinx/themes/pyramid/static/epub.css
+++ b/sphinx/themes/pyramid/static/epub.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- default theme.
*
- * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/sphinx/themes/pyramid/static/pyramid.css_t b/sphinx/themes/pyramid/static/pyramid.css_t
index e3b2ae1e1..c4e949088 100644
--- a/sphinx/themes/pyramid/static/pyramid.css_t
+++ b/sphinx/themes/pyramid/static/pyramid.css_t
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- pylons theme.
*
- * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/sphinx/themes/scrolls/layout.html b/sphinx/themes/scrolls/layout.html
index 97f7ca1db..48e5e4e46 100644
--- a/sphinx/themes/scrolls/layout.html
+++ b/sphinx/themes/scrolls/layout.html
@@ -32,7 +32,7 @@
{%- if display_toc %}
-
Table Of Contents
+ {{ _('Table Of Contents') }}
{{ toc }}
{%- endif %}
diff --git a/sphinx/transforms.py b/sphinx/transforms.py
index 97721eb5e..26495a099 100644
--- a/sphinx/transforms.py
+++ b/sphinx/transforms.py
@@ -22,6 +22,7 @@ from sphinx.locale import _, init as init_locale
from sphinx.util import split_index_msg
from sphinx.util.nodes import traverse_translatable_index, extract_messages
from sphinx.util.osutil import ustrftime, find_catalog
+from sphinx.util.compat import docutils_version
from sphinx.util.pycompat import all
@@ -131,21 +132,14 @@ class CustomLocaleReporter(object):
"""
Replacer for document.reporter.get_source_and_line method.
- reST text lines for translation not have original source line number.
- This class provide correct line number at reporting.
+ reST text lines for translation do not have the original source line number.
+ This class provides the correct line numbers when reporting.
"""
def __init__(self, source, line):
self.source, self.line = source, line
- try:
- from docutils import __version__ as du_version
- v = tuple([int(x) for x in du_version.split('.')[:2]])
- except ImportError:
- v = (99, 99)
- self.du_version = v
-
def set_reporter(self, document):
- if self.du_version < (0, 9):
+ if docutils_version < (0, 9):
document.reporter.locator = self.get_source_and_line
else:
document.reporter.get_source_and_line = self.get_source_and_line
diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py
index 916f6fa3b..4b7cbf6dc 100644
--- a/sphinx/util/compat.py
+++ b/sphinx/util/compat.py
@@ -11,6 +11,9 @@
from docutils import nodes
+from docutils import __version__ as _du_version
+docutils_version = tuple(int(x) for x in _du_version.split('.')[:2])
+
def make_admonition(node_class, name, arguments, options, content, lineno,
content_offset, block_text, state, state_machine):
#if not content:
@@ -33,14 +36,4 @@ def make_admonition(node_class, name, arguments, options, content, lineno,
state.nested_parse(content, content_offset, admonition_node)
return [admonition_node]
-
-# backwards-compatibility aliases for helpers in older Sphinx versions that
-# supported the docutils 0.4 directive function interface
-
from docutils.parsers.rst import Directive
-
-def directive_dwim(obj):
- import warnings
- warnings.warn('directive_dwim is deprecated and no longer needed',
- DeprecationWarning, stacklevel=2)
- return obj
diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py
index 5a7749bef..62ad5d773 100644
--- a/sphinx/util/nodes.py
+++ b/sphinx/util/nodes.py
@@ -10,6 +10,7 @@
"""
import re
+import sys
from docutils import nodes
@@ -215,18 +216,6 @@ def set_role_source_info(inliner, lineno, node):
# docutils 0.9+
node.source, node.line = inliner.reporter.get_source_and_line(lineno)
-# monkey-patch Node.__contains__ to get consistent "in" operator behavior
-# across docutils versions
-
-def _new_contains(self, key):
- # support both membership test for children and attributes
- # (has_key is translated to "in" by 2to3)
- if isinstance(key, basestring):
- return key in self.attributes
- return key in self.children
-
-nodes.Node.__contains__ = _new_contains
-
# monkey-patch Element.copy to copy the rawsource
def _new_copy(self):
@@ -234,16 +223,16 @@ def _new_copy(self):
nodes.Element.copy = _new_copy
-# monkey-patch Element.__repr__ to return str if include unicode.
-# sf.net/tracker/?func=detail&aid=3601607&group_id=38414&atid=422030
-import sys
+# monkey-patch Element.__repr__ to return str if it returns unicode.
+# Was fixed in docutils since 0.10. See sf.net/p/docutils/bugs/218/.
+
if sys.version_info < (3,):
_element_repr_orig = nodes.Element.__repr__
-
- def _repr(self):
+
+ def _new_repr(self):
s = _element_repr_orig(self)
if isinstance(s, unicode):
return s.encode('utf-8')
return s
-
- nodes.Element.__repr__ = _repr
+
+ nodes.Element.__repr__ = _new_repr
diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py
index 7322289ef..6cb310eb0 100644
--- a/sphinx/util/osutil.py
+++ b/sphinx/util/osutil.py
@@ -14,6 +14,7 @@ import re
import sys
import time
import errno
+import locale
import shutil
from os import path
@@ -135,10 +136,12 @@ def make_filename(string):
return no_fn_re.sub('', string)
if sys.version_info < (3, 0):
+ # strftime for unicode strings
def ustrftime(format, *args):
- # strftime for unicode strings
- return time.strftime(unicode(format).encode('utf-8'), *args) \
- .decode('utf-8')
+ # if a locale is set, the time strings are encoded in the encoding
+ # given by LC_TIME; if that is available, use it
+ enc = locale.getlocale(locale.LC_TIME)[1] or 'utf-8'
+ return time.strftime(unicode(format).encode(enc), *args).decode(enc)
else:
ustrftime = time.strftime
@@ -159,4 +162,3 @@ def find_catalog(docname, compaction):
return ret
fs_encoding = sys.getfilesystemencoding() or sys.getdefaultencoding()
-
diff --git a/sphinx/websupport/__init__.py b/sphinx/websupport/__init__.py
index 55d56fa03..e82ac8bb1 100644
--- a/sphinx/websupport/__init__.py
+++ b/sphinx/websupport/__init__.py
@@ -19,6 +19,7 @@ from jinja2 import Environment, FileSystemLoader
from docutils.core import publish_parts
from sphinx.application import Sphinx
+from sphinx.locale import _
from sphinx.util.osutil import ensuredir
from sphinx.util.jsonimpl import dumps as dump_json
from sphinx.util.pycompat import htmlescape
@@ -217,6 +218,7 @@ class WebSupport(object):
'search_performed': True,
'search_results': results,
'docroot': '../', # XXX
+ '_': _,
}
document = {
'body': self.results_template.render(ctx),
diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py
index 252cedc41..d450b2c74 100644
--- a/sphinx/writers/html.py
+++ b/sphinx/writers/html.py
@@ -17,7 +17,7 @@ from docutils import nodes
from docutils.writers.html4css1 import Writer, HTMLTranslator as BaseTranslator
from sphinx import addnodes
-from sphinx.locale import admonitionlabels, versionlabels, _
+from sphinx.locale import admonitionlabels, _
from sphinx.util.smartypants import sphinx_smarty_pants
try:
@@ -157,15 +157,9 @@ class HTMLTranslator(BaseTranslator):
self.body.append('')
def visit_versionmodified(self, node):
- self.body.append(self.starttag(node, 'p', CLASS=node['type']))
- text = versionlabels[node['type']] % node['version']
- if len(node):
- text += ': '
- else:
- text += '.'
- self.body.append('
%s' % text)
+ self.body.append(self.starttag(node, 'div', CLASS=node['type']))
def depart_versionmodified(self, node):
- self.body.append('\n')
+ self.body.append('
\n')
# overwritten
def visit_reference(self, node):
@@ -310,6 +304,9 @@ class HTMLTranslator(BaseTranslator):
if isinstance(node.parent, addnodes.desc_content):
# Never compact desc_content items.
return False
+ if isinstance(node.parent, addnodes.versionmodified):
+ # Never compact versionmodified nodes.
+ return False
return BaseTranslator.should_be_compact_paragraph(self, node)
def visit_compact_paragraph(self, node):
diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py
index ef2197c6a..a9e98abf2 100644
--- a/sphinx/writers/latex.py
+++ b/sphinx/writers/latex.py
@@ -22,7 +22,7 @@ from docutils.writers.latex2e import Babel
from sphinx import addnodes
from sphinx import highlighting
from sphinx.errors import SphinxError
-from sphinx.locale import admonitionlabels, versionlabels, _
+from sphinx.locale import admonitionlabels, _
from sphinx.util import split_into
from sphinx.util.osutil import ustrftime
from sphinx.util.pycompat import any
@@ -562,10 +562,12 @@ class LaTeXTranslator(nodes.NodeVisitor):
def visit_desc_name(self, node):
self.body.append(r'\bfcode{')
+ self.no_contractions += 1
self.literal_whitespace += 1
def depart_desc_name(self, node):
self.body.append('}')
self.literal_whitespace -= 1
+ self.no_contractions -= 1
def visit_desc_parameterlist(self, node):
# close name, open parameterlist
@@ -757,10 +759,11 @@ class LaTeXTranslator(nodes.NodeVisitor):
self.table.rowcount += 1
def visit_entry(self, node):
- if self.remember_multirow.get(0, 0) > 1:
- self.body.append(' & ')
if self.table.col > 0:
self.body.append(' & ')
+ elif self.remember_multirow.get(1, 0) > 1:
+ self.remember_multirow[1] -= 1
+ self.body.append(' & ')
self.table.col += 1
context = ''
if 'morerows' in node:
@@ -779,7 +782,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
self.body.append('}{l|}{')
context += '}'
if isinstance(node.parent.parent, nodes.thead):
- self.body.append('\\textbf{')
+ self.body.append('\\textbf{\\relax ')
context += '}'
if self.remember_multirow.get(self.table.col + 1, 0) > 1:
self.remember_multirow[self.table.col + 1] -= 1
@@ -1053,12 +1056,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
depart_warning = _depart_named_admonition
def visit_versionmodified(self, node):
- intro = versionlabels[node['type']] % node['version']
- if node.children:
- intro += ': '
- else:
- intro += '.'
- self.body.append(intro)
+ pass
def depart_versionmodified(self, node):
pass
@@ -1312,6 +1310,10 @@ class LaTeXTranslator(nodes.NodeVisitor):
pass
def visit_literal_block(self, node):
+ if self.in_footnote:
+ raise UnsupportedError('%s:%s: literal blocks in footnotes are '
+ 'not supported by LaTeX' %
+ (self.curfilestack[-1], node.line))
self.verbatim = ''
def depart_literal_block(self, node):
code = self.verbatim.rstrip('\n')
@@ -1496,6 +1498,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
text = text.replace(u'\n', u'~\\\\\n').replace(u' ', u'~')
if self.no_contractions:
text = text.replace('--', u'-{-}')
+ text = text.replace("''", u"'{'}")
return text
def encode_uri(self, text):
diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py
index 6e405d5aa..6b68971e0 100644
--- a/sphinx/writers/manpage.py
+++ b/sphinx/writers/manpage.py
@@ -20,7 +20,7 @@ except ImportError:
has_manpage_writer = False
from sphinx import addnodes
-from sphinx.locale import admonitionlabels, versionlabels, _
+from sphinx.locale import admonitionlabels, _
from sphinx.util.osutil import ustrftime
@@ -157,12 +157,6 @@ class ManualPageTranslator(BaseTranslator):
def visit_versionmodified(self, node):
self.visit_paragraph(node)
- text = versionlabels[node['type']] % node['version']
- if len(node):
- text += ': '
- else:
- text += '.'
- self.body.append(text)
def depart_versionmodified(self, node):
self.depart_paragraph(node)
diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py
index aa7ed6855..cf5cb9eed 100644
--- a/sphinx/writers/texinfo.py
+++ b/sphinx/writers/texinfo.py
@@ -17,7 +17,7 @@ from os import path
from docutils import nodes, writers
from sphinx import addnodes, __version__
-from sphinx.locale import admonitionlabels, versionlabels, _
+from sphinx.locale import admonitionlabels, _
from sphinx.util import ustrftime
from sphinx.writers.latex import collected_footnote
@@ -1225,12 +1225,7 @@ class TexinfoTranslator(nodes.NodeVisitor):
self.body.append('\n')
def visit_versionmodified(self, node):
- intro = versionlabels[node['type']] % node['version']
- if node.children:
- intro += ': '
- else:
- intro += '.'
- self.body.append('\n%s' % self.escape(intro))
+ self.body.append('\n')
def depart_versionmodified(self, node):
self.body.append('\n')
diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py
index 965769117..d2c2fcba8 100644
--- a/sphinx/writers/text.py
+++ b/sphinx/writers/text.py
@@ -17,7 +17,7 @@ from docutils import nodes, writers
from docutils.utils import column_width
from sphinx import addnodes
-from sphinx.locale import admonitionlabels, versionlabels, _
+from sphinx.locale import admonitionlabels, _
class TextWrapper(textwrap.TextWrapper):
@@ -32,8 +32,8 @@ class TextWrapper(textwrap.TextWrapper):
def _wrap_chunks(self, chunks):
"""_wrap_chunks(chunks : [string]) -> [string]
- Original _wrap_chunks use len() to calculate width.
- This method respect to wide/fullwidth characters for width adjustment.
+ The original _wrap_chunks uses len() to calculate width.
+ This method respects wide/fullwidth characters for width adjustment.
"""
drop_whitespace = getattr(self, 'drop_whitespace', True) #py25 compat
lines = []
@@ -680,10 +680,6 @@ class TextTranslator(nodes.NodeVisitor):
def visit_versionmodified(self, node):
self.new_state(0)
- if node.children:
- self.add_text(versionlabels[node['type']] % node['version'] + ': ')
- else:
- self.add_text(versionlabels[node['type']] % node['version'] + '.')
def depart_versionmodified(self, node):
self.end_state()
diff --git a/sphinx/writers/websupport.py b/sphinx/writers/websupport.py
index 71a9ba00d..63b5dd1da 100644
--- a/sphinx/writers/websupport.py
+++ b/sphinx/writers/websupport.py
@@ -42,5 +42,5 @@ class WebSupportTranslator(HTMLTranslator):
storage = self.builder.storage
if not storage.has_node(node.uid):
storage.add_node(id=node.uid,
- document=self.builder.cur_docname,
+ document=self.builder.current_docname,
source=node.rawsource or node.astext())
diff --git a/tests/path.py b/tests/path.py
old mode 100644
new mode 100755
index bd0552d70..fa478557d
--- a/tests/path.py
+++ b/tests/path.py
@@ -1,10 +1,10 @@
#!/usr/bin/env python
-# coding: utf-8
+# -*- coding: utf-8 -*-
"""
path
~~~~
- :copyright: Copyright 2010 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import os
diff --git a/tests/root/markup.txt b/tests/root/markup.txt
index cbfbbbe3d..1fb20cf09 100644
--- a/tests/root/markup.txt
+++ b/tests/root/markup.txt
@@ -208,6 +208,15 @@ Version markup
.. deprecated:: 0.6
Boring stuff.
+.. versionadded:: 1.2
+
+ First paragraph of versionadded.
+
+.. versionchanged:: 1.2
+ First paragraph of versionchanged.
+
+ Second paragraph of versionchanged.
+
Code blocks
-----------
diff --git a/tests/roots/test-intl/_templates/index.html b/tests/roots/test-intl/_templates/index.html
new file mode 100644
index 000000000..22bc0e832
--- /dev/null
+++ b/tests/roots/test-intl/_templates/index.html
@@ -0,0 +1,5 @@
+{% extends "layout.html" %}
+{% block body %}
+
{{ _('Welcome') }}
+
{%trans%}Sphinx {{ version }}{%endtrans%}
+{% endblock %}
diff --git a/tests/roots/test-intl/conf.py b/tests/roots/test-intl/conf.py
index 457c5056f..4c37f7718 100644
--- a/tests/roots/test-intl/conf.py
+++ b/tests/roots/test-intl/conf.py
@@ -1,7 +1,8 @@
# -*- coding: utf-8 -*-
-import sys, os
-
project = 'Sphinx intl
'
source_suffix = '.txt'
keep_warnings = True
+templates_path = ['_templates']
+html_additional_pages = {'index': 'index.html'}
+release = version = '2013.120'
diff --git a/tests/roots/test-intl/contents.txt b/tests/roots/test-intl/contents.txt
index a3c0e3549..b08fc3617 100644
--- a/tests/roots/test-intl/contents.txt
+++ b/tests/roots/test-intl/contents.txt
@@ -19,4 +19,5 @@ CONTENTS
role_xref
glossary_terms
glossary_terms_inconsistency
+ versionchange
docfields
diff --git a/tests/roots/test-intl/sphinx.po b/tests/roots/test-intl/sphinx.po
new file mode 100644
index 000000000..cac5d4ad2
--- /dev/null
+++ b/tests/roots/test-intl/sphinx.po
@@ -0,0 +1,23 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2012, foof
+# This file is distributed under the same license as the foo package.
+# FIRST AUTHOR , YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: sphinx 1.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2012-11-22 08:28\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME \n"
+"Language-Team: LANGUAGE \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+msgid "Welcome"
+msgstr "WELCOME"
+
+msgid "Sphinx %(version)s"
+msgstr "SPHINX %(version)s"
diff --git a/tests/roots/test-intl/versionchange.po b/tests/roots/test-intl/versionchange.po
new file mode 100644
index 000000000..911d3d9f4
--- /dev/null
+++ b/tests/roots/test-intl/versionchange.po
@@ -0,0 +1,33 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2010, Georg Brandl & Team
+# This file is distributed under the same license as the Sphinx package.
+# FIRST AUTHOR , YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: sphinx 1.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2012-12-15 03:17\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME \n"
+"Language-Team: LANGUAGE \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+msgid "i18n with versionchange"
+msgstr "I18N WITH VERSIONCHANGE"
+
+msgid "This is the *first* paragraph of deprecated."
+msgstr "THIS IS THE *FIRST* PARAGRAPH OF DEPRECATED."
+
+msgid "This is the *second* paragraph of deprecated."
+msgstr "THIS IS THE *SECOND* PARAGRAPH OF DEPRECATED."
+
+msgid "This is the *first* paragraph of versionadded."
+msgstr "THIS IS THE *FIRST* PARAGRAPH OF VERSIONADDED."
+
+msgid "This is the *first* paragraph of versionchanged."
+msgstr "THIS IS THE *FIRST* PARAGRAPH OF VERSIONCHANGED."
+
diff --git a/tests/roots/test-intl/versionchange.txt b/tests/roots/test-intl/versionchange.txt
new file mode 100644
index 000000000..4c57e14e3
--- /dev/null
+++ b/tests/roots/test-intl/versionchange.txt
@@ -0,0 +1,16 @@
+:tocdepth: 2
+
+i18n with versionchange
+============================
+
+.. deprecated:: 1.0
+ This is the *first* paragraph of deprecated.
+
+ This is the *second* paragraph of deprecated.
+
+.. versionadded:: 1.0
+ This is the *first* paragraph of versionadded.
+
+.. versionchanged:: 1.0
+
+ This is the *first* paragraph of versionchanged.
diff --git a/tests/test_application.py b/tests/test_application.py
index 87ec42f01..a0a288b93 100644
--- a/tests/test_application.py
+++ b/tests/test_application.py
@@ -15,7 +15,7 @@ from docutils import nodes
from sphinx.application import ExtensionError
from sphinx.domains import Domain
-from util import *
+from util import with_app, raises_msg, TestApp
@with_app()
diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py
index fcd064929..aabc1bd72 100644
--- a/tests/test_autodoc.py
+++ b/tests/test_autodoc.py
@@ -13,7 +13,8 @@
import sys
from StringIO import StringIO
-from util import *
+# "raises" imported for usage by autodoc
+from util import TestApp, Struct, raises
from nose.tools import with_setup
from docutils.statemachine import ViewList
@@ -21,6 +22,7 @@ from docutils.statemachine import ViewList
from sphinx.ext.autodoc import AutoDirective, add_documenter, \
ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL
+app = None
def setup_module():
global app
@@ -36,6 +38,8 @@ def teardown_module():
app.cleanup()
+directive = options = None
+
def setup_test():
global options, directive
global processed_docstrings, processed_signatures, _warnings
@@ -191,7 +195,8 @@ def test_format_signature():
class G2(F2, object):
pass
for C in (F2, G2):
- assert formatsig('class', 'C', C, None, None) == '(a1, a2, kw1=True, kw2=False)'
+ assert formatsig('class', 'C', C, None, None) == \
+ '(a1, a2, kw1=True, kw2=False)'
# test for methods
class H:
diff --git a/tests/test_autosummary.py b/tests/test_autosummary.py
index dab72c1e5..cb6a6b745 100644
--- a/tests/test_autosummary.py
+++ b/tests/test_autosummary.py
@@ -9,8 +9,6 @@
:license: BSD, see LICENSE for details.
"""
-from util import *
-
from sphinx.ext.autosummary import mangle_signature
diff --git a/tests/test_build.py b/tests/test_build.py
index c2f0b38d1..b172184b1 100644
--- a/tests/test_build.py
+++ b/tests/test_build.py
@@ -9,7 +9,7 @@
:license: BSD, see LICENSE for details.
"""
-from util import *
+from util import with_app, test_root, path
from textwrap import dedent
diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py
index f6cb4b8e2..ca0ff0d2c 100644
--- a/tests/test_build_gettext.py
+++ b/tests/test_build_gettext.py
@@ -5,7 +5,7 @@
Test the build process with gettext builder with the test root.
- :copyright: Copyright 2010 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
@@ -14,8 +14,7 @@ import os
import re
from subprocess import Popen, PIPE
-from util import *
-from util import SkipTest
+from util import test_root, test_roots, with_app, SkipTest
def teardown_module():
@@ -137,3 +136,15 @@ def test_gettext_index_entries(app):
# unexpected msgid existent
assert msgids == []
+
+
+@with_app(buildername='gettext',
+ srcdir=(test_roots / 'test-intl'),
+ doctreedir=(test_roots / 'test-intl' / '_build' / 'doctree'))
+def test_gettext_template(app):
+ app.builder.build_all()
+ assert (app.outdir / 'sphinx.pot').isfile()
+
+ result = (app.outdir / 'sphinx.pot').text(encoding='utf-8')
+ assert "Welcome" in result
+ assert "Sphinx %(version)s" in result
diff --git a/tests/test_build_html.py b/tests/test_build_html.py
index abd60bbb5..3890f6e1b 100644
--- a/tests/test_build_html.py
+++ b/tests/test_build_html.py
@@ -21,7 +21,7 @@ except ImportError:
pygments = None
from sphinx import __version__
-from util import *
+from util import test_root, remove_unicode_literals, gen_with_app
from etree13 import ElementTree as ET
@@ -144,7 +144,13 @@ HTML_XPATH = {
# abbreviations
(".//abbr[@title='abbreviation']", '^abbr$'),
# version stuff
- (".//span[@class='versionmodified']", 'New in version 0.6'),
+ (".//div[@class='versionadded']/p/span", 'New in version 0.6: '),
+ (".//div[@class='versionadded']/p/span",
+ tail_check('First paragraph of versionadded')),
+ (".//div[@class='versionchanged']/p/span",
+ tail_check('First paragraph of versionchanged')),
+ (".//div[@class='versionchanged']/p",
+ 'Second paragraph of versionchanged'),
# footnote reference
(".//a[@class='footnote-reference']", r'\[1\]'),
# created by reference lookup
diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py
index 721b3a2dd..bb79e52cf 100644
--- a/tests/test_build_latex.py
+++ b/tests/test_build_latex.py
@@ -17,7 +17,7 @@ from subprocess import Popen, PIPE
from sphinx.writers.latex import LaTeXTranslator
-from util import *
+from util import test_root, SkipTest, remove_unicode_literals, with_app
from test_build_html import ENV_WARNINGS
@@ -69,17 +69,13 @@ def test_latex(app):
return True
if kpsetest('article.sty') is None:
- print >>sys.stderr, \
- 'info: not running latex, it doesn\'t seem to be installed'
- return
+ raise SkipTest('not running latex, it doesn\'t seem to be installed')
for filename in ['fancyhdr.sty', 'fancybox.sty', 'titlesec.sty',
'amsmath.sty', 'framed.sty', 'color.sty', 'fancyvrb.sty',
'threeparttable.sty']:
if not kpsetest(filename):
- print >>sys.stderr, \
- 'info: not running latex, the %s package doesn\'t ' \
- 'seem to be installed' % filename
- return
+ raise SkipTest('not running latex, the %s package doesn\'t '
+ 'seem to be installed' % filename)
# now, try to run latex over it
cwd = os.getcwd()
diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py
index 37ad0582a..587d123b9 100644
--- a/tests/test_build_texinfo.py
+++ b/tests/test_build_texinfo.py
@@ -17,7 +17,7 @@ from subprocess import Popen, PIPE
from sphinx.writers.texinfo import TexinfoTranslator
-from util import *
+from util import with_app, test_root, remove_unicode_literals
from test_build_html import ENV_WARNINGS
diff --git a/tests/test_build_text.py b/tests/test_build_text.py
index 41603d502..445e39db6 100644
--- a/tests/test_build_text.py
+++ b/tests/test_build_text.py
@@ -9,12 +9,10 @@
:license: BSD, see LICENSE for details.
"""
-from textwrap import dedent
-
from docutils.utils import column_width
from sphinx.writers.text import MAXWIDTH
-from util import *
+from util import with_app
def with_text_app(*args, **kw):
diff --git a/tests/test_config.py b/tests/test_config.py
index 84a3b4b77..4d3d51b09 100644
--- a/tests/test_config.py
+++ b/tests/test_config.py
@@ -11,9 +11,8 @@
"""
import sys
-from util import *
+from util import TestApp, with_app, with_tempdir, raises, raises_msg, write_file
-import sphinx
from sphinx.config import Config
from sphinx.errors import ExtensionError, ConfigError, VersionRequirementError
from sphinx.util.pycompat import b
diff --git a/tests/test_coverage.py b/tests/test_coverage.py
index 88c66140f..6ba005429 100644
--- a/tests/test_coverage.py
+++ b/tests/test_coverage.py
@@ -11,7 +11,7 @@
import pickle
-from util import *
+from util import with_app
@with_app(buildername='coverage')
diff --git a/tests/test_cpp_domain.py b/tests/test_cpp_domain.py
index db2589d50..2168d7e44 100644
--- a/tests/test_cpp_domain.py
+++ b/tests/test_cpp_domain.py
@@ -9,7 +9,7 @@
:license: BSD, see LICENSE for details.
"""
-from util import *
+from util import raises
from sphinx.domains.cpp import DefinitionParser, DefinitionError
diff --git a/tests/test_doctest.py b/tests/test_doctest.py
index 4934e716b..f445dab2a 100644
--- a/tests/test_doctest.py
+++ b/tests/test_doctest.py
@@ -12,7 +12,8 @@
import sys
import StringIO
-from util import *
+from util import with_app
+
status = StringIO.StringIO()
cleanup_called = 0
diff --git a/tests/test_env.py b/tests/test_env.py
index 12e0719da..2b03bbfb9 100644
--- a/tests/test_env.py
+++ b/tests/test_env.py
@@ -10,7 +10,7 @@
"""
import sys
-from util import *
+from util import TestApp, remove_unicode_literals, path
from sphinx.builders.html import StandaloneHTMLBuilder
from sphinx.builders.latex import LaTeXBuilder
diff --git a/tests/test_footnote.py b/tests/test_footnote.py
index 3a3d59670..96dea6163 100644
--- a/tests/test_footnote.py
+++ b/tests/test_footnote.py
@@ -5,13 +5,13 @@
Test for footnote and citation.
- :copyright: Copyright 2010 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import re
-from util import *
+from util import test_root, with_app
def teardown_module():
diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py
index b392193d6..888d4c214 100644
--- a/tests/test_highlighting.py
+++ b/tests/test_highlighting.py
@@ -9,20 +9,19 @@
:license: BSD, see LICENSE for details.
"""
-from util import *
-
-try:
- import pygments
-except ImportError:
- from nose.plugins.skip import SkipTest
- raise SkipTest('pygments not available')
-
from pygments.lexer import RegexLexer
from pygments.token import Text, Name
from pygments.formatters.html import HtmlFormatter
from sphinx.highlighting import PygmentsBridge
+from util import with_app, SkipTest
+
+try:
+ import pygments
+except ImportError:
+ raise SkipTest('pygments not available')
+
class MyLexer(RegexLexer):
name = 'testlexer'
diff --git a/tests/test_i18n.py b/tests/test_i18n.py
index 210243e79..e67c96c78 100644
--- a/tests/test_i18n.py
+++ b/tests/test_i18n.py
@@ -9,7 +9,7 @@
:license: BSD, see LICENSE for details.
"""
-from util import *
+from util import with_app
@with_app(confoverrides={'language': 'de'})
diff --git a/tests/test_intersphinx.py b/tests/test_intersphinx.py
index 0171ae035..a8679e7e2 100644
--- a/tests/test_intersphinx.py
+++ b/tests/test_intersphinx.py
@@ -22,7 +22,7 @@ from sphinx import addnodes
from sphinx.ext.intersphinx import read_inventory_v1, read_inventory_v2, \
load_mappings, missing_reference
-from util import *
+from util import with_app, with_tempdir, write_file
inventory_v1 = '''\
@@ -178,5 +178,3 @@ def test_load_mappings_warnings(tempdir, app):
# load the inventory and check if it's done correctly
load_mappings(app)
assert len(app._warning.content) == 2
-
-
diff --git a/tests/test_intl.py b/tests/test_intl.py
index 77b5a5616..10583b952 100644
--- a/tests/test_intl.py
+++ b/tests/test_intl.py
@@ -6,19 +6,18 @@
Test message patching for internationalization purposes. Runs the text
builder in the test root.
- :copyright: Copyright 2010 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
-from subprocess import Popen, PIPE
-import re
import os
+import re
from StringIO import StringIO
+from subprocess import Popen, PIPE
from sphinx.util.pycompat import relpath
-from util import *
-from util import SkipTest
+from util import test_roots, path, with_app, SkipTest
warnfile = StringIO()
@@ -299,9 +298,11 @@ def test_i18n_role_xref(app):
app.builddir.rmtree(True) #for warnings acceleration
app.builder.build(['role_xref'])
result = (app.outdir / 'role_xref.txt').text(encoding='utf-8')
- expect = (u"\nI18N ROCK'N ROLE XREF"
- u"\n*********************\n"
- u"\nLINK TO *I18N ROCK'N ROLE XREF*, *CONTENTS*, *SOME NEW TERM*.\n")
+ expect = (
+ u"\nI18N ROCK'N ROLE XREF"
+ u"\n*********************\n"
+ u"\nLINK TO *I18N ROCK'N ROLE XREF*, *CONTENTS*, *SOME NEW TERM*.\n"
+ )
warnings = warnfile.getvalue().replace(os.sep, '/')
assert 'term not in glossary' not in warnings
@@ -389,6 +390,39 @@ def test_i18n_index_entries(app):
assert re.search(expr, result, re.M)
+@with_intl_app(buildername='html', cleanenv=True)
+def test_versionchange(app):
+ app.builder.build(['versionchange'])
+ result = (app.outdir / 'versionchange.html').text(encoding='utf-8')
+
+ def get_content(result, name):
+ matched = re.search(r'\n*(.*?)
' % name,
+ result, re.DOTALL)
+ if matched:
+ return matched.group(1)
+ else:
+ return ''
+
+ expect1 = (
+ u"""Deprecated since version 1.0: """
+ u"""THIS IS THE FIRST PARAGRAPH OF DEPRECATED.
\n"""
+ u"""THIS IS THE SECOND PARAGRAPH OF DEPRECATED.
\n""")
+ matched_content = get_content(result, "deprecated")
+ assert expect1 == matched_content
+
+ expect2 = (
+ u"""New in version 1.0: """
+ u"""THIS IS THE FIRST PARAGRAPH OF VERSIONADDED.
\n""")
+ matched_content = get_content(result, "versionadded")
+ assert expect2 == matched_content
+
+ expect3 = (
+ u"""Changed in version 1.0: """
+ u"""THIS IS THE FIRST PARAGRAPH OF VERSIONCHANGED.
\n""")
+ matched_content = get_content(result, "versionchanged")
+ assert expect3 == matched_content
+
+
@with_intl_app(buildername='text', cleanenv=True)
def test_i18n_docfields(app):
app.builder.build(['docfields'])
@@ -420,3 +454,11 @@ def test_i18n_docfields_html(app):
app.builder.build(['docfields'])
result = (app.outdir / 'docfields.html').text(encoding='utf-8')
# expect no error by build
+
+
+@with_intl_app(buildername='html')
+def test_gettext_template(app):
+ app.builder.build_all()
+ result = (app.outdir / 'index.html').text(encoding='utf-8')
+ assert "WELCOME" in result
+ assert "SPHINX 2013.120" in result
diff --git a/tests/test_linkcode.py b/tests/test_linkcode.py
index 6e9bd6f87..507cd9ce9 100644
--- a/tests/test_linkcode.py
+++ b/tests/test_linkcode.py
@@ -10,7 +10,7 @@
"""
import os
-from util import *
+from util import with_app
@with_app(srcdir='(temp)', buildername='html', tags=['test_linkcode'])
def test_html(app):
diff --git a/tests/test_markup.py b/tests/test_markup.py
index c72b6b913..311222ba1 100644
--- a/tests/test_markup.py
+++ b/tests/test_markup.py
@@ -11,8 +11,6 @@
import re
-from util import *
-
from docutils import frontend, utils, nodes
from docutils.parsers import rst
@@ -21,6 +19,11 @@ from sphinx.util.pycompat import b
from sphinx.writers.html import HTMLWriter, SmartyPantsHTMLTranslator
from sphinx.writers.latex import LaTeXWriter, LaTeXTranslator
+from util import TestApp
+
+
+app = settings = parser = None
+
def setup_module():
global app, settings, parser
texescape.init() # otherwise done by the latex builder
diff --git a/tests/test_metadata.py b/tests/test_metadata.py
index b4a064baf..db955390d 100644
--- a/tests/test_metadata.py
+++ b/tests/test_metadata.py
@@ -12,7 +12,7 @@
# adapted from an example of bibliographic metadata at
# http://docutils.sourceforge.net/docs/user/rst/demo.txt
-from util import *
+from util import TestApp
from nose.tools import assert_equals
diff --git a/tests/test_only_directive.py b/tests/test_only_directive.py
index af1462c03..28e34e58b 100644
--- a/tests/test_only_directive.py
+++ b/tests/test_only_directive.py
@@ -5,7 +5,7 @@
Test the only directive with the test root.
- :copyright: Copyright 2010 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
@@ -13,7 +13,7 @@ import re
from docutils import nodes
-from util import *
+from util import with_app, test_roots
def teardown_module():
diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py
index b0815447d..2340e04b7 100644
--- a/tests/test_quickstart.py
+++ b/tests/test_quickstart.py
@@ -12,7 +12,7 @@
import sys
import time
-from util import *
+from util import raises, with_tempdir
from sphinx import quickstart as qs
from sphinx.util.console import nocolor, coloron
diff --git a/tests/test_searchadapters.py b/tests/test_searchadapters.py
index 551eefb9e..ad1e58f2b 100644
--- a/tests/test_searchadapters.py
+++ b/tests/test_searchadapters.py
@@ -9,15 +9,13 @@
:license: BSD, see LICENSE for details.
"""
-import os, sys
+import os
from StringIO import StringIO
-from nose import SkipTest
-
from sphinx.websupport import WebSupport
from test_websupport import sqlalchemy_missing
-from util import *
+from util import test_root, skip_if, skip_unless_importable
def clear_builddir():
diff --git a/tests/test_theming.py b/tests/test_theming.py
index 141aa0889..2e297aedc 100644
--- a/tests/test_theming.py
+++ b/tests/test_theming.py
@@ -12,10 +12,10 @@
import os
import zipfile
-from util import *
-
from sphinx.theming import Theme, ThemeError
+from util import with_app, raises
+
@with_app(confoverrides={'html_theme': 'ziptheme',
'html_theme_options.testopt': 'foo'})
diff --git a/tests/test_versioning.py b/tests/test_versioning.py
index 08238f4a1..6469a33cc 100644
--- a/tests/test_versioning.py
+++ b/tests/test_versioning.py
@@ -8,17 +8,20 @@
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
+
import pickle
-from util import *
-
-from docutils.statemachine import ViewList
from docutils.parsers.rst.directives.html import MetaBody
from sphinx import addnodes
from sphinx.versioning import add_uids, merge_doctrees, get_ratio
from sphinx.util.pycompat import all
+from util import test_root, TestApp
+
+
+app = original = original_uids = None
+
def setup_module():
global app, original, original_uids
app = TestApp()
diff --git a/tests/test_websupport.py b/tests/test_websupport.py
index ff9fb1ecb..611a131ac 100644
--- a/tests/test_websupport.py
+++ b/tests/test_websupport.py
@@ -19,7 +19,8 @@ except ImportError:
wraps = lambda f: (lambda w: w)
from sphinx.websupport import WebSupport
-from sphinx.websupport.errors import *
+from sphinx.websupport.errors import DocumentNotFoundError, \
+ CommentNotAllowedError, UserNotAuthorizedError
from sphinx.websupport.storage import StorageBackend
from sphinx.websupport.storage.differ import CombinedHtmlDiff
try:
@@ -30,7 +31,7 @@ try:
except ImportError:
sqlalchemy_missing = True
-from util import *
+from util import test_root, raises, skip_if
default_settings = {'builddir': os.path.join(test_root, 'websupport'),
diff --git a/tox.ini b/tox.ini
index b08d6b293..92cea737c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -16,6 +16,8 @@ commands=
deps=
simplejson==2.5.0
{[testenv]deps}
+setenv=
+ PIP_INSECURE = 1
[testenv:py33]
deps=
diff --git a/utils/convert.py b/utils/convert.py
old mode 100644
new mode 100755
index f025c49a0..6f4618229
--- a/utils/convert.py
+++ b/utils/convert.py
@@ -8,7 +8,7 @@
The Python3 version of a file foo.py will be called foo3.py.
- :copyright: Copyright 2010 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import os