Sphinx 4 Support (#110)

Co-authored-by: Pradyun Gedam <3275593+pradyunsg@users.noreply.github.com>

Author: Daltz333

.github/workflows/tests.yml

@@ -30,7 +30,7 @@ jobs:
     strategy:
       matrix:
         python-version: [3.6, 3.7, 3.8]
-        sphinx: [">=2,<3", ">=3,<4"]
+        sphinx: [">=2,<3", ">=3,<4", "==4.0.0b1"]
 
     steps:
     - uses: actions/checkout@v2

setup.py

@@ -25,7 +25,7 @@ def get_version():
     url="https://github.com/executablebooks/sphinx-tabs",
     license="MIT",
     python_requires="~=3.6",
-    install_requires=["sphinx>=2,<4", "pygments"],
+    install_requires=["sphinx>=2,<5", "pygments", "docutils~=0.16.0"],
     extras_require={
         "testing": [
             "coverage",

tests/test_build.py

@@ -1,4 +1,5 @@
 import pytest
+import sphinx
 from sphinx.application import Sphinx
 
 
@@ -22,10 +23,21 @@ def test_conditional_assets(app, docname, check_asset_links):
 
 
 @pytest.mark.sphinx(testroot="linenos")
+@pytest.mark.skipif(
+    sphinx.version_info[:2] >= (4, 0), reason="Test uses Sphinx 3 code blocks"
+)
 def test_other_with_assets(app, check_asset_links):
     check_asset_links(app)
 
 
+@pytest.mark.sphinx(testroot="linenos")
+@pytest.mark.skipif(
+    sphinx.version_info[:2] <= (4, 0), reason="Test uses Sphinx 4 code blocks"
+)
+def test_other_With_assets_new_style(app, check_asset_links):
+    check_asset_links(app)
+
+
 @pytest.mark.sphinx(testroot="nestedmarkup")
 def test_nested_markup(app, check_asset_links):
     check_asset_links(app)

tests/test_build/test_other_with_assets_new_style.html

@@ -0,0 +1,32 @@
+<div class="documentwrapper">
+ <div class="bodywrapper">
+  <div class="body" role="main">
+   <div class="sphinx-tabs docutils container">
+    <div aria-label="Tabbed content" class="closeable" role="tablist">
+     <button aria-controls="panel-0-Qysr" aria-selected="true" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-Qysr" name="Qysr" role="tab" tabindex="0">
+      C++
+     </button>
+     <button aria-controls="panel-0-UHl0aG9u" aria-selected="false" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-UHl0aG9u" name="UHl0aG9u" role="tab" tabindex="-1">
+      Python
+     </button>
+    </div>
+    <div aria-labelledby="tab-0-Qysr" class="sphinx-tabs-panel code-tab group-tab" id="panel-0-Qysr" name="Qysr" role="tabpanel" tabindex="0">
+     <div class="highlight-c++ notranslate">
+      <div class="highlight">
+       <pre><span></span><span class="linenos">1</span><span class="n">std</span><span class="o">::</span><span class="n">cout</span> <span class="o">&lt;&lt;</span> <span class="s">"hello world"</span> <span class="o">&lt;&lt;</span> <span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span>
+</pre>
+      </div>
+     </div>
+    </div>
+    <div aria-labelledby="tab-0-UHl0aG9u" class="sphinx-tabs-panel code-tab group-tab" hidden="true" id="panel-0-UHl0aG9u" name="UHl0aG9u" role="tabpanel" tabindex="0">
+     <div class="highlight-python notranslate">
+      <div class="highlight">
+       <pre><span></span><span class="nb">print</span><span class="p">(</span><span class="s1">'hello world'</span><span class="p">)</span>
+</pre>
+      </div>
+     </div>
+    </div>
+   </div>
+  </div>
+ </div>
+</div>

tests/test_build/test_other_with_assets_new_style.xml

@@ -0,0 +1,13 @@
+<document source="index.rst">
+    <container classes="sphinx-tabs" type="tab-element">
+        <div aria-label="Tabbed content" classes="closeable" role="tablist">
+            <button aria-controls="panel-0-Qysr" aria-selected="true" classes="sphinx-tabs-tab code-tab group-tab" ids="tab-0-Qysr" name="Qysr" role="tab" tabindex="0">
+                C++
+            <button aria-controls="panel-0-UHl0aG9u" aria-selected="false" classes="sphinx-tabs-tab code-tab group-tab" ids="tab-0-UHl0aG9u" name="UHl0aG9u" role="tab" tabindex="-1">
+                Python
+        <div aria-labelledby="tab-0-Qysr" classes="sphinx-tabs-panel code-tab group-tab" ids="panel-0-Qysr" name="Qysr" role="tabpanel" tabindex="0">
+            <literal_block force="False" highlight_args="{}" language="c++" linenos="True" xml:space="preserve">
+                std::cout << "hello world" << std::endl;
+        <div aria-labelledby="tab-0-UHl0aG9u" classes="sphinx-tabs-panel code-tab group-tab" hidden="true" ids="panel-0-UHl0aG9u" name="UHl0aG9u" role="tabpanel" tabindex="0">
+            <literal_block force="False" highlight_args="{}" language="python" xml:space="preserve">
+                print('hello world')

tox.ini

@@ -4,13 +4,14 @@
 # then run `tox` or `tox -- {pytest args}`
 # run in parallel using `tox -p`
 [tox]
-envlist = py{36,37,38}-sphinx{2,3},docs
+envlist = py{36,37,38}-sphinx{2,3,4},docs
 
-[testenv:py{36,37,38}-sphinx{2,3}]
+[testenv:py{36,37,38}-sphinx{2,3,4}]
 extras = testing
 deps =
     sphinx2: sphinx>=2,<3
     sphinx3: sphinx>=3,<4
+    sphinx4: sphinx>=4,<5
 recreate = false
 commands = pytest {posargs}