Merge pull request #3276 from akien-mga/extensions-pip

Install sphinx_tabs using pip requirements.txt + rename folder to _extensions

conf.py

@@ -11,8 +11,12 @@ import os
 needs_sphinx = "1.3"
 
 # Sphinx extension module names and templates location
-sys.path.append(os.path.abspath("extensions"))
-extensions = ["gdscript", "sphinx_tabs.tabs", "sphinx.ext.imgmath"]
+sys.path.append(os.path.abspath("_extensions"))
+extensions = [
+    "gdscript",
+    "sphinx_tabs.tabs",
+    "sphinx.ext.imgmath",
+]
 
 templates_path = ["_templates"]
 
@@ -51,7 +55,7 @@ exclude_patterns = ["_build"]
 
 # fmt: off
 # These imports should *not* be moved to the start of the file,
-# they depend on the sys.path.append call registering "extensions".
+# they depend on the sys.path.append call registering "_extensions".
 # GDScript syntax highlighting
 from gdscript import GDScriptLexer
 from sphinx.highlighting import lexers

extensions/sphinx_tabs/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 djungelorm
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

extensions/sphinx_tabs/__init__.py

@@ -1 +0,0 @@
-__import__('pkg_resources').declare_namespace(__name__)

extensions/sphinx_tabs/semantic-ui-2.2.10/LICENSE.md

@@ -1,7 +0,0 @@
-# The MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

extensions/sphinx_tabs/semantic-ui-2.2.10/tab.min.css

@@ -1,9 +0,0 @@
-/*!
- * # Semantic UI 2.2.10 - Tab
- * http://github.com/semantic-org/semantic-ui/
- *
- *
- * Released under the MIT license
- * http://opensource.org/licenses/MIT
- *
- */.ui.tab{display:none}.ui.tab.active,.ui.tab.open{display:block}.ui.tab.loading{position:relative;overflow:hidden;display:block;min-height:250px}.ui.tab.loading *{position:relative!important;left:-10000px!important}.ui.tab.loading.segment:before,.ui.tab.loading:before{position:absolute;content:'';top:100px;left:50%;margin:-1.25em 0 0 -1.25em;width:2.5em;height:2.5em;border-radius:500rem;border:.2em solid rgba(0,0,0,.1)}.ui.tab.loading.segment:after,.ui.tab.loading:after{position:absolute;content:'';top:100px;left:50%;margin:-1.25em 0 0 -1.25em;width:2.5em;height:2.5em;-webkit-animation:button-spin .6s linear;animation:button-spin .6s linear;-webkit-animation-iteration-count:infinite;animation-iteration-count:infinite;border-radius:500rem;border-color:#767676 transparent transparent;border-style:solid;border-width:.2em;box-shadow:0 0 0 1px transparent}

extensions/sphinx_tabs/tabs.css

@@ -1,43 +0,0 @@
-.sphinx-tabs {
-    margin-bottom: 2em;
-}
-
-.sphinx-tabs .sphinx-menu a.item {
-    color: #2980b9 !important;
-}
-
-.sphinx-tabs .sphinx-menu {
-    border-bottom-color: #a0b3bf !important;
-    display: flex;
-    flex-direction: row;
-    flex-wrap: wrap;
-}
-
-.sphinx-tabs .sphinx-menu a.active.item {
-    border-color: #a0b3bf !important;
-}
-
-.sphinx-tab {
-    border-color: #a0b3bf !important;
-    box-sizing: border-box;
-}
-
-.tab div[class^='highlight']:last-child {
-    margin-bottom: 0;
-}
-
-.tab .wy-plain-list-disc:last-child,
-.rst-content .section ul:last-child,
-.rst-content .toctree-wrapper ul:last-child,
-article ul:last-child {
-    margin-bottom: 0;
-}
-
-/* Code tabs don't need the code-block border */
-.code-tab.tab {
-    padding: 0.4em !important;
-}
-
-.code-tab.tab div[class^='highlight'] {
-    border: none;
-}

extensions/sphinx_tabs/tabs.js

@@ -1,85 +0,0 @@
-// From http://stackoverflow.com/questions/123999/how-to-tell-if-a-dom-element-is-visible-in-the-current-viewport
-function elementIsInView (el) {
-  if (typeof jQuery === "function" && el instanceof jQuery) {
-    el = el[0];
-  }
-
-  const  rect = el.getBoundingClientRect();
-
-  return (
-    rect.top >= 0 &&
-    rect.left >= 0 &&
-    rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) &&
-    rect.right <= (window.innerWidth || document.documentElement.clientWidth)
-  );
-}
-
-$(function() {
-  // Change container tags <div> -> <a>
-  $('.sphinx-menu.menu .item').each(function() {
-    var this_ = $(this);
-    var a_this = $('<a>');
-
-    a_this.html(this_.html());
-    $.each(this_.prop('attributes'), function() {
-      a_this.attr(this.name, this.value);
-    });
-
-    this_.replaceWith(a_this);
-  });
-
-  // We store the data-tab values as sphinx-data-<data-tab value>
-  // Add data-tab attribute with the extracted value
-  $('.sphinx-menu.menu .item, .sphinx-tab.tab').each(function() {
-    var this_ = $(this);
-    const prefix = 'sphinx-data-';
-    const classes = this_.attr('class').split(/\s+/);
-    $.each(classes, function(idx, clazz) {
-      if (clazz.startsWith(prefix)) {
-        this_.attr('data-tab',
-                   clazz.substring(prefix.length));
-      }
-    });
-  });
-
-  // Mimic the Semantic UI behaviour
-  $('.sphinx-menu.menu .item').each(function() {
-    var this1 = $(this);
-    var data_tab = this1.attr('data-tab');
-
-    this1.on('click', function() {
-      // Find offset in view
-      const offset = (this1.offset().top - $(window).scrollTop());
-
-      // Enable all tabs with this id
-
-      // For each tab group
-      $('.sphinx-tabs').each(function() {
-        var this2 = $(this);
-
-        // Check if tab group has a tab matching the clicked tab
-        var has_tab = false;
-        this2.children().eq(0).children().each(function() {
-          has_tab |= $(this).attr('data-tab') === data_tab;
-        });
-
-        if (has_tab) {
-          // Enable just the matching tab
-          var toggle = function() {
-            var this3 = $(this);
-            if (this3.attr('data-tab') === data_tab) {
-              this3.addClass('active');
-            } else {
-              this3.removeClass('active');
-            }
-          };
-          this2.children().eq(0).children('[data-tab]').each(toggle);
-          this2.children('[data-tab]').each(toggle);
-        }
-      });
-
-      // Keep tab with the original view offset
-      $(window).scrollTop(this1.offset().top - offset);
-    });
-  });
-});

extensions/sphinx_tabs/tabs.py

@@ -1,348 +0,0 @@
-""" Tabbed views for Sphinx, with HTML builder """
-
-import base64
-import json
-import posixpath
-import os
-from docutils import nodes
-from docutils.parsers.rst import Directive, directives
-from pkg_resources import resource_filename
-from pygments.lexers import get_all_lexers
-from sphinx.util.osutil import copyfile
-from sphinx.util import logging
-
-
-FILES = [
-    'tabs.js',
-    'tabs.css',
-    'semantic-ui-2.2.10/segment.min.css',
-    'semantic-ui-2.2.10/menu.min.css',
-    'semantic-ui-2.2.10/tab.min.css',
-    'semantic-ui-2.2.10/tab.min.js',
-]
-
-
-LEXER_MAP = {}
-for lexer in get_all_lexers():
-    for short_name in lexer[1]:
-        LEXER_MAP[short_name] = lexer[0]
-
-
-def get_compatible_builders(app):
-    builders = ['html', 'singlehtml', 'dirhtml',
-                'readthedocs', 'readthedocsdirhtml',
-                'readthedocssinglehtml', 'readthedocssinglehtmllocalmedia',
-                'spelling']
-    builders.extend(app.config['sphinx_tabs_valid_builders'])
-    return builders
-
-
-class TabsDirective(Directive):
-    """ Top-level tabs directive """
-
-    has_content = True
-
-    def run(self):
-        """ Parse a tabs directive """
-        self.assert_has_content()
-        env = self.state.document.settings.env
-
-        node = nodes.container()
-        node['classes'] = ['sphinx-tabs']
-
-        if 'next_tabs_id' not in env.temp_data:
-            env.temp_data['next_tabs_id'] = 0
-        if 'tabs_stack' not in env.temp_data:
-            env.temp_data['tabs_stack'] = []
-
-        tabs_id = env.temp_data['next_tabs_id']
-        tabs_key = 'tabs_%d' % tabs_id
-        env.temp_data['next_tabs_id'] += 1
-        env.temp_data['tabs_stack'].append(tabs_id)
-
-        env.temp_data[tabs_key] = {}
-        env.temp_data[tabs_key]['tab_ids'] = []
-        env.temp_data[tabs_key]['tab_titles'] = []
-        env.temp_data[tabs_key]['is_first_tab'] = True
-
-        self.state.nested_parse(self.content, self.content_offset, node)
-
-        if env.app.builder.name in get_compatible_builders(env.app):
-            tabs_node = nodes.container()
-            tabs_node.tagname = 'div'
-
-            classes = 'ui top attached tabular menu sphinx-menu'
-            tabs_node['classes'] = classes.split(' ')
-
-            tab_titles = env.temp_data[tabs_key]['tab_titles']
-            for idx, [data_tab, tab_name] in enumerate(tab_titles):
-                tab = nodes.container()
-                tab.tagname = 'a'
-                tab['classes'] = ['item'] if idx > 0 else ['active', 'item']
-                tab['classes'].append(data_tab)
-                tab += tab_name
-                tabs_node += tab
-
-            node.children.insert(0, tabs_node)
-
-        env.temp_data['tabs_stack'].pop()
-        return [node]
-
-
-class TabDirective(Directive):
-    """ Tab directive, for adding a tab to a collection of tabs """
-
-    has_content = True
-
-    def run(self):
-        """ Parse a tab directive """
-        self.assert_has_content()
-        env = self.state.document.settings.env
-
-        tabs_id = env.temp_data['tabs_stack'][-1]
-        tabs_key = 'tabs_%d' % tabs_id
-
-        args = self.content[0].strip()
-        if args.startswith('{'):
-            try:
-                args = json.loads(args)
-                self.content.trim_start(1)
-            except ValueError:
-                args = {}
-        else:
-            args = {}
-
-        tab_name = nodes.container()
-        self.state.nested_parse(
-            self.content[:1], self.content_offset, tab_name)
-        args['tab_name'] = tab_name
-
-        include_tabs_id_in_data_tab = False
-        if 'tab_id' not in args:
-            args['tab_id'] = env.new_serialno(tabs_key)
-            include_tabs_id_in_data_tab = True
-        i = 1
-        while args['tab_id'] in env.temp_data[tabs_key]['tab_ids']:
-            args['tab_id'] = '%s-%d' % (args['tab_id'], i)
-            i += 1
-        env.temp_data[tabs_key]['tab_ids'].append(args['tab_id'])
-
-        data_tab = str(args['tab_id'])
-        if include_tabs_id_in_data_tab:
-            data_tab = '%d-%s' % (tabs_id, data_tab)
-        data_tab = "sphinx-data-tab-{}".format(data_tab)
-
-        env.temp_data[tabs_key]['tab_titles'].append(
-            (data_tab, args['tab_name']))
-
-        text = '\n'.join(self.content)
-        node = nodes.container(text)
-
-        classes = 'ui bottom attached sphinx-tab tab segment'
-        node['classes'] = classes.split(' ')
-        node['classes'].extend(args.get('classes', []))
-        node['classes'].append(data_tab)
-
-        if env.temp_data[tabs_key]['is_first_tab']:
-            node['classes'].append('active')
-            env.temp_data[tabs_key]['is_first_tab'] = False
-
-        self.state.nested_parse(self.content[2:], self.content_offset, node)
-
-        if env.app.builder.name not in get_compatible_builders(env.app):
-            outer_node = nodes.container()
-            tab = nodes.container()
-            tab.tagname = 'a'
-            tab['classes'] = ['item']
-            tab += tab_name
-
-            outer_node.append(tab)
-            outer_node.append(node)
-            return [outer_node]
-
-        return [node]
-
-
-class GroupTabDirective(Directive):
-    """ Tab directive that toggles with same tab names across page"""
-
-    has_content = True
-
-    def run(self):
-        """ Parse a tab directive """
-        self.assert_has_content()
-
-        group_name = self.content[0]
-        self.content.trim_start(2)
-
-        for idx, line in enumerate(self.content.data):
-            self.content.data[idx] = '   ' + line
-
-        tab_args = {
-            'tab_id': base64.b64encode(
-                group_name.encode('utf-8')).decode('utf-8'),
-            'group_tab': True
-        }
-
-        new_content = [
-            '.. tab:: {}'.format(json.dumps(tab_args)),
-            '   {}'.format(group_name),
-            '',
-        ]
-
-        for idx, line in enumerate(new_content):
-            self.content.data.insert(idx, line)
-            self.content.items.insert(idx, (None, idx))
-
-        node = nodes.container()
-        self.state.nested_parse(self.content, self.content_offset, node)
-        return node.children
-
-
-class CodeTabDirective(Directive):
-    """ Tab directive with a codeblock as its content"""
-
-    has_content = True
-    option_spec = {
-        'linenos': directives.flag
-    }
-
-    def run(self):
-        """ Parse a tab directive """
-        self.assert_has_content()
-
-        args = self.content[0].strip().split()
-        self.content.trim_start(2)
-
-        lang = args[0]
-        tab_name = ' '.join(args[1:]) if len(args) > 1 else LEXER_MAP[lang]
-
-        for idx, line in enumerate(self.content.data):
-            self.content.data[idx] = '      ' + line
-
-        tab_args = {
-            'tab_id': base64.b64encode(
-                tab_name.encode('utf-8')).decode('utf-8'),
-            'classes': ['code-tab'],
-        }
-
-        new_content = [
-            '.. tab:: {}'.format(json.dumps(tab_args)),
-            '   {}'.format(tab_name),
-            '',
-            '   .. code-block:: {}'.format(lang),
-        ]
-
-        if 'linenos' in self.options:
-            new_content.append('      :linenos:')
-
-        new_content.append('')
-
-        for idx, line in enumerate(new_content):
-            self.content.data.insert(idx, line)
-            self.content.items.insert(idx, (None, idx))
-
-        node = nodes.container()
-        self.state.nested_parse(self.content, self.content_offset, node)
-        return node.children
-
-
-class _FindTabsDirectiveVisitor(nodes.NodeVisitor):
-    """ Visitor pattern than looks for a sphinx tabs
-        directive in a document """
-    def __init__(self, document):
-        nodes.NodeVisitor.__init__(self, document)
-        self._found = False
-
-    def unknown_visit(self, node):
-        if not self._found and isinstance(node, nodes.container) and \
-           'classes' in node and isinstance(node['classes'], list):
-            self._found = 'sphinx-tabs' in node['classes']
-
-    @property
-    def found_tabs_directive(self):
-        """ Return whether a sphinx tabs directive was found """
-        return self._found
-
-
-# pylint: disable=unused-argument
-def update_context(app, pagename, templatename, context, doctree):
-    """ Remove sphinx-tabs CSS and JS asset files if not used in a page """
-    if doctree is None:
-        return
-    visitor = _FindTabsDirectiveVisitor(doctree)
-    doctree.walk(visitor)
-    if not visitor.found_tabs_directive:
-        paths = [posixpath.join('_static', 'sphinx_tabs/' + f) for f in FILES]
-        if 'css_files' in context:
-            context['css_files'] = context['css_files'][:]
-            for path in paths:
-                if path.endswith('.css'):
-                    context['css_files'].remove(path)
-        if 'script_files' in context:
-            context['script_files'] = context['script_files'][:]
-            for path in paths:
-                if path.endswith('.js'):
-                    context['script_files'].remove(path)
-# pylint: enable=unused-argument
-
-
-def copy_assets(app, exception):
-    """ Copy asset files to the output """
-    if 'getLogger' in dir(logging):
-        log = logging.getLogger(__name__).info  # pylint: disable=no-member
-        warn = logging.getLogger(__name__).warning  # pylint: disable=no-member
-    else:
-        log = app.info
-        warn = app.warn
-    builders = get_compatible_builders(app)
-    if exception:
-        return
-    if app.builder.name not in builders:
-        if not app.config['sphinx_tabs_nowarn']:
-            warn(
-                'Not copying tabs assets! Not compatible with %s builder' %
-                app.builder.name)
-        return
-
-    log('Copying tabs assets')
-
-    installdir = os.path.join(app.builder.outdir, '_static', 'sphinx_tabs')
-
-    for path in FILES:
-        source = resource_filename('sphinx_tabs', path)
-        dest = os.path.join(installdir, path)
-
-        destdir = os.path.dirname(dest)
-        if not os.path.exists(destdir):
-            os.makedirs(destdir)
-
-        copyfile(source, dest)
-
-
-def setup(app):
-    """ Set up the plugin """
-    app.add_config_value('sphinx_tabs_nowarn', False, '')
-    app.add_config_value('sphinx_tabs_valid_builders', [], '')
-    app.add_directive('tabs', TabsDirective)
-    app.add_directive('tab', TabDirective)
-    app.add_directive('group-tab', GroupTabDirective)
-    app.add_directive('code-tab', CodeTabDirective)
-    for path in ['sphinx_tabs/' + f for f in FILES]:
-        if path.endswith('.css'):
-            if 'add_css_file' in dir(app):
-                app.add_css_file(path)
-            else:
-                app.add_stylesheet(path)
-        if path.endswith('.js'):
-            if 'add_script_file' in dir(app):
-                app.add_script_file(path)
-            else:
-                app.add_javascript(path)
-    app.connect('html-page-context', update_context)
-    app.connect('build-finished', copy_assets)
-
-    return {
-        'parallel_read_safe': True,
-        'parallel_write_safe': True,
-    }

requirements.txt

@@ -0,0 +1,2 @@
+# Code tabs for GDScript/C#
+sphinx-tabs