From fc680f1e25959ccc0e210dd6d5070dca360208c7 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 3 Sep 2014 16:39:30 +0200 Subject: [PATCH] Return version from setup() for all sphinx.ext extensions. --- sphinx/ext/autodoc.py | 3 +++ sphinx/ext/autosummary/__init__.py | 2 ++ sphinx/ext/coverage.py | 2 ++ sphinx/ext/doctest.py | 2 ++ sphinx/ext/extlinks.py | 2 ++ sphinx/ext/graphviz.py | 2 ++ sphinx/ext/ifconfig.py | 2 ++ sphinx/ext/inheritance_diagram.py | 2 ++ sphinx/ext/intersphinx.py | 2 ++ sphinx/ext/jsmath.py | 2 ++ sphinx/ext/linkcode.py | 2 ++ sphinx/ext/mathjax.py | 2 ++ sphinx/ext/napoleon/__init__.py | 2 ++ sphinx/ext/pngmath.py | 2 ++ sphinx/ext/todo.py | 2 ++ sphinx/ext/viewcode.py | 2 ++ 16 files changed, 33 insertions(+) diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index 918d6549a..5b014d0d5 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -22,6 +22,7 @@ from docutils import nodes from docutils.utils import assemble_option_dict from docutils.statemachine import ViewList +import sphinx from sphinx.util import rpartition, force_decode from sphinx.locale import _ from sphinx.pycode import ModuleAnalyzer, PycodeError @@ -1503,6 +1504,8 @@ def setup(app): app.add_event('autodoc-process-signature') app.add_event('autodoc-skip-member') + return sphinx.__version__ + class testcls: """test doc string""" diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index e3e97676c..31bbfb8a5 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -64,6 +64,7 @@ from docutils.parsers.rst import directives from docutils.statemachine import ViewList from docutils import nodes +import sphinx from sphinx import addnodes from sphinx.util.compat import Directive from sphinx.pycode import ModuleAnalyzer, PycodeError @@ -569,3 +570,4 @@ def setup(app): app.connect('doctree-read', process_autosummary_toc) app.connect('builder-inited', process_generate_options) app.add_config_value('autosummary_generate', [], True) + return sphinx.__version__ diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index 3d2da66d4..49dc02f44 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -18,6 +18,7 @@ from os import path from six import iteritems from six.moves import cPickle as pickle +import sphinx from sphinx.builders import Builder @@ -264,3 +265,4 @@ def setup(app): app.add_config_value('coverage_ignore_c_items', {}, False) app.add_config_value('coverage_write_headline', True, False) app.add_config_value('coverage_skip_undoc_in_source', False, False) + return sphinx.__version__ diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index b7e247ec9..20b8692f1 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -22,6 +22,7 @@ from six import itervalues, StringIO, binary_type from docutils import nodes from docutils.parsers.rst import directives +import sphinx from sphinx.builders import Builder from sphinx.util import force_decode from sphinx.util.nodes import set_source_info @@ -434,3 +435,4 @@ def setup(app): app.add_config_value('doctest_test_doctest_blocks', 'default', False) app.add_config_value('doctest_global_setup', '', False) app.add_config_value('doctest_global_cleanup', '', False) + return sphinx.__version__ diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py index 2a54761af..c0cfbcd2b 100644 --- a/sphinx/ext/extlinks.py +++ b/sphinx/ext/extlinks.py @@ -27,6 +27,7 @@ from six import iteritems from docutils import nodes, utils +import sphinx from sphinx.util.nodes import split_explicit_title @@ -58,3 +59,4 @@ def setup_link_roles(app): def setup(app): app.add_config_value('extlinks', {}, 'env') app.connect('builder-inited', setup_link_roles) + return sphinx.__version__ diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index 3c2bacee3..b4b8bc276 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -22,6 +22,7 @@ from docutils import nodes from docutils.parsers.rst import directives from docutils.statemachine import ViewList +import sphinx from sphinx.errors import SphinxError from sphinx.locale import _ from sphinx.util.osutil import ensuredir, ENOENT, EPIPE, EINVAL @@ -322,3 +323,4 @@ def setup(app): app.add_config_value('graphviz_dot', 'dot', 'html') app.add_config_value('graphviz_dot_args', [], 'html') app.add_config_value('graphviz_output_format', 'png', 'html') + return sphinx.__version__ diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 58ab9b40a..ab15e1e1f 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -22,6 +22,7 @@ from docutils import nodes +import sphinx from sphinx.util.nodes import set_source_info from sphinx.util.compat import Directive @@ -72,3 +73,4 @@ def setup(app): app.add_node(ifconfig) app.add_directive('ifconfig', IfConfig) app.connect('doctree-resolved', process_ifconfig_nodes) + return sphinx.__version__ diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index 2263b9c63..bbae5c110 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -49,6 +49,7 @@ from six import text_type from docutils import nodes from docutils.parsers.rst import directives +import sphinx from sphinx.ext.graphviz import render_dot_html, render_dot_latex, \ render_dot_texinfo from sphinx.pycode import ModuleAnalyzer @@ -406,3 +407,4 @@ def setup(app): app.add_config_value('inheritance_graph_attrs', {}, False), app.add_config_value('inheritance_node_attrs', {}, False), app.add_config_value('inheritance_edge_attrs', {}, False), + return sphinx.__version__ diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index 320a9eb4c..43507a383 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -36,6 +36,7 @@ from six.moves.urllib import request from docutils import nodes from docutils.utils import relative_path +import sphinx from sphinx.locale import _ from sphinx.builders.html import INVENTORY_FILENAME @@ -275,3 +276,4 @@ def setup(app): app.add_config_value('intersphinx_cache_limit', 5, False) app.connect('missing-reference', missing_reference) app.connect('builder-inited', load_mappings) + return sphinx.__version__ diff --git a/sphinx/ext/jsmath.py b/sphinx/ext/jsmath.py index 8907576f5..897d87acb 100644 --- a/sphinx/ext/jsmath.py +++ b/sphinx/ext/jsmath.py @@ -12,6 +12,7 @@ from docutils import nodes +import sphinx from sphinx.application import ExtensionError from sphinx.ext.mathbase import setup_math as mathbase_setup @@ -56,3 +57,4 @@ def setup(app): mathbase_setup(app, (html_visit_math, None), (html_visit_displaymath, None)) app.add_config_value('jsmath_path', '', False) app.connect('builder-inited', builder_inited) + return sphinx.__version__ diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index 77bd9f28a..bbb0698cd 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -11,6 +11,7 @@ from docutils import nodes +import sphinx from sphinx import addnodes from sphinx.locale import _ from sphinx.errors import SphinxError @@ -70,3 +71,4 @@ def doctree_read(app, doctree): def setup(app): app.connect('doctree-read', doctree_read) app.add_config_value('linkcode_resolve', None, '') + return sphinx.__version__ diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index 472ec55fd..fd5c5f1d3 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -13,6 +13,7 @@ from docutils import nodes +import sphinx from sphinx.application import ExtensionError from sphinx.ext.mathbase import setup_math as mathbase_setup @@ -68,3 +69,4 @@ def setup(app): app.add_config_value('mathjax_inline', [r'\(', r'\)'], 'html') app.add_config_value('mathjax_display', [r'\[', r'\]'], 'html') app.connect('builder-inited', builder_inited) + return sphinx.__version__ diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index 655a07a05..554162ede 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -13,6 +13,7 @@ import sys from six import PY2, iteritems +import sphinx from sphinx.ext.napoleon.docstring import GoogleDocstring, NumpyDocstring @@ -255,6 +256,7 @@ def setup(app): for name, (default, rebuild) in iteritems(Config._config_values): app.add_config_value(name, default, rebuild) + return sphinx.__version__ def _process_docstring(app, what, name, obj, options, lines): diff --git a/sphinx/ext/pngmath.py b/sphinx/ext/pngmath.py index 7b1af9705..ee108d166 100644 --- a/sphinx/ext/pngmath.py +++ b/sphinx/ext/pngmath.py @@ -21,6 +21,7 @@ from hashlib import sha1 from six import text_type from docutils import nodes +import sphinx from sphinx.errors import SphinxError from sphinx.util.png import read_png_depth, write_png_depth from sphinx.util.osutil import ensuredir, ENOENT @@ -245,3 +246,4 @@ def setup(app): app.add_config_value('pngmath_latex_preamble', '', 'html') app.add_config_value('pngmath_add_tooltips', True, 'html') app.connect('build-finished', cleanup_tempdir) + return sphinx.__version__ diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index 5422c89af..d70617b9d 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -14,6 +14,7 @@ from docutils import nodes +import sphinx from sphinx.locale import _ from sphinx.environment import NoUri from sphinx.util.nodes import set_source_info @@ -171,3 +172,4 @@ def setup(app): app.connect('doctree-read', process_todos) app.connect('doctree-resolved', process_todo_nodes) app.connect('env-purge-doc', purge_todos) + return sphinx.__version__ diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 9976ecc4a..3653a2da4 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -14,6 +14,7 @@ import traceback from six import iteritems, text_type from docutils import nodes +import sphinx from sphinx import addnodes from sphinx.locale import _ from sphinx.pycode import ModuleAnalyzer @@ -203,3 +204,4 @@ def setup(app): app.connect('missing-reference', missing_reference) #app.add_config_value('viewcode_include_modules', [], 'env') #app.add_config_value('viewcode_exclude_modules', [], 'env') + return sphinx.__version__