🧪 TESTS: Add testing for Python 3.9 and pygments versions (#135)

* Include testing for python 3.9

* Remove pygments output from regression test HTML

* Add pygments version paramtrization to Actions CI

* Change CI sphinx version from pre-release

* Add new regression outputs for Sphinx 4

* Change test to use independent root

Author: foster999

.github/workflows/tests.yml

@@ -17,8 +17,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
-        sphinx: [">=2,<3", ">=3,<4", "==4.0.0b1"]
+        python-version: [3.6, 3.7, 3.8, 3.9]
+        sphinx: [">=2,<3", ">=3,<4", ">=4,<5"]
+        pygments: ["==2.8.0", "==2.9.0", "==2.10.0"]
 
     steps:
     - uses: actions/checkout@v2
@@ -30,6 +31,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install "sphinx${{ matrix.sphinx }}"
+        pip install "pygments${{ matrix.pygments }}"
         pip install .[testing]
     - name: Run pytest
       run: |

tests/conftest.py

@@ -75,17 +75,19 @@ def regress_sphinx_app_output(file_regression, get_sphinx_app_output):
     non-deterministic).
     """
 
-    def read(
-        app, buildername="html", filename="index.html", encoding="utf-8", replace=None
-    ):
+    def read(app, buildername="html", filename="index.html", encoding="utf-8"):
         content = get_sphinx_app_output(app, buildername, filename, encoding)
 
         if buildername == "html":
             soup = BeautifulSoup(content, "html.parser")
+
+            # Remove output from ``pygments``, so that test only compares HTML of surrounding tabs
+            for div in soup.find_all("div", {"class": "highlight"}):
+                div.decompose()
+
             doc_div = soup.findAll("div", {"class": "documentwrapper"})[0]
             doc = doc_div.prettify()
-            for find, rep in (replace or {}).items():
-                doc = text.replace(find, rep)
+
         else:
             doc = content
         file_regression.check(

tests/roots/test-conditionalassets-policy/conf.py

@@ -0,0 +1,5 @@
+project = "sphinx-tabs test"
+master_doc = "index"
+source_suffix = ".rst"
+extensions = ["sphinx_tabs.tabs"]
+pygments_style = "sphinx"

tests/roots/test-conditionalassets-policy/index.rst

@@ -0,0 +1,130 @@
+.. toctree::
+
+   no_tabs1
+   no_tabs2
+
+Fruits
+========================================
+
+.. tabs::
+
+   .. tab:: Apples
+
+      Apples are green, or sometimes red.
+
+   .. tab:: Pears
+
+      Pears are green.
+
+   .. tab:: Oranges
+
+      Oranges are orange.
+
+Luminaries
+========================================
+
+.. tabs::
+
+   .. tab:: Sun
+
+      The sun is a star.
+
+   .. tab:: Moon
+
+      The moon is not a star.
+
+Code Tabs
+========================================
+
+.. tabs::
+
+   .. code-tab:: c
+
+         C Main Function
+
+   .. code-tab:: c++
+
+         C++ Main Function
+
+   .. code-tab:: py
+
+         Python Main Function
+
+   .. code-tab:: java
+
+         Java Main Function
+
+   .. code-tab:: julia
+
+         Julia Main Function
+
+   .. code-tab:: fortran
+
+         Fortran Main Function
+
+.. tabs::
+
+   .. code-tab:: c
+
+         int main(const int argc, const char **argv) {
+           return 0;
+         }
+
+   .. code-tab:: c++
+
+         int main(const int argc, const char **argv) {
+           return 0;
+         }
+
+   .. code-tab:: py
+
+         def main():
+             return
+
+   .. code-tab:: java
+
+         class Main {
+             public static void main(String[] args) {
+             }
+         }
+
+   .. code-tab:: julia
+
+         function main()
+         end
+
+   .. code-tab:: fortran
+
+         PROGRAM main
+         END PROGRAM main
+
+Group Tabs
+========================================
+
+.. tabs::
+
+   .. group-tab:: Linux
+
+      Linux Line 1
+
+   .. group-tab:: Mac OSX
+
+      Mac OSX Line 1
+
+   .. group-tab:: Windows
+
+      Windows Line 1
+
+.. tabs::
+
+   .. group-tab:: Linux
+
+      Linux Line 2
+
+   .. group-tab:: Mac OSX
+
+      Mac OSX Line 2
+
+   .. group-tab:: Windows
+
+      Windows Line 2

tests/roots/test-conditionalassets-policy/no_tabs1.rst

@@ -0,0 +1,4 @@
+Another page without tabs
+========================================
+
+No tabs to see here

tests/roots/test-conditionalassets-policy/no_tabs2.rst

@@ -0,0 +1,4 @@
+And another page without tabs
+========================================
+
+No tabs to see here either

tests/test_build.py

@@ -27,7 +27,7 @@ def test_conditional_assets(app, docname, check_asset_links):
 
 @pytest.mark.noautobuild
 @pytest.mark.parametrize("docname", ["index", "no_tabs1", "no_tabs2"])
-@pytest.mark.sphinx(testroot="conditionalassets")
+@pytest.mark.sphinx(testroot="conditionalassets-policy")
 @pytest.mark.skipif(
     sphinx.version_info[:2] < (4, 1), reason="Test uses Sphinx 4.1 config"
 )