🧪 TESTS: Add Windows to test matrix (#10)

Author: chrisjsewell

.github/workflows/tests.yml

@@ -26,10 +26,15 @@ jobs:
 
   tests:
 
-    runs-on: ubuntu-latest
     strategy:
       matrix:
+        os: [ubuntu-latest]
         python-version: [3.6, 3.7, 3.8, 3.9]
+        include:
+        - os: windows-latest
+          python-version: 3.8
+
+    runs-on: ${{ matrix.os }}
 
     steps:
     - uses: actions/checkout@v2

README.md

@@ -228,14 +228,13 @@ Process:
 - Read toc ("builder-inited" event), error if toc not found
   - Note, in jupyter-book: if index page does not exist, works out first page from toc and creates an index page that just redirects to it)
 - adds toctree node to page doctree after it is parsed ("doctree-read" event)
-  - Note, in jupyter-book this was done by physically addingto the text before parsing ("source-read" event), but this is not as robust.
+  - Note, in jupyter-book this was done by physically adding to the text before parsing ("source-read" event), but this is not as robust.
 
 Questions / TODOs:
 
 - Should `titlesonly` default to `True` (as in jupyter-book)?
 - nested numbered toctree not allowed (logs warning), so should be handled if `numbered: true` is in defaults
 - Add additional top-level keys, e.g. `appendices` and `bibliography`
-- testing against Windows (including toc with subfolders)
 - Add tests for "bad" toc files
 - Using `external_toc_exclude_missing` to exclude a certain file suffix:
   currently if you had files `doc.md` and `doc.rst`, and put `doc.md` in your ToC,

setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
 name = sphinx_external_toc
 version = attr: sphinx_external_toc.__version__
-description = A sphinx extension that allows the documentation toctree to be defined in a single file.
+description = A sphinx extension that allows the site-map to be defined in a single YAML file.
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/executablebooks/sphinx-external-toc

sphinx_external_toc/tools.py

@@ -1,6 +1,5 @@
 from itertools import chain
 from pathlib import Path, PurePosixPath
-from os import linesep
 import shutil
 from typing import Mapping, Optional, Sequence, Union
 
@@ -73,6 +72,8 @@ def create_site_from_toc(
         if extra_lines:
             content.extend(extra_lines + [""])
 
-        docpath.write_text(linesep.join(content), encoding=encoding)
+        # note \n works when writing for all platforms:
+        # https://docs.python.org/3/library/os.html#os.linesep
+        docpath.write_text("\n".join(content), encoding=encoding)
 
     return site_map

tests/_toc_files/basic.yml

@@ -11,5 +11,5 @@ main:
       - file: doc3
         parts:
         - sections:
-          - file: doc4
+          - file: subfolder/doc4
           - url: https://example.com

tests/test_api/test_file_to_sitemap_basic_.yml

@@ -14,15 +14,11 @@ doc3:
     numbered: false
     reversed: false
     sections:
-    - doc4
+    - subfolder/doc4
     - title: null
       url: https://example.com
     titlesonly: true
   title: null
-doc4:
-  docname: doc4
-  parts: []
-  title: null
 intro:
   docname: intro
   parts:
@@ -35,3 +31,7 @@ intro:
     - doc3
     titlesonly: true
   title: Introduction
+subfolder/doc4:
+  docname: subfolder/doc4
+  parts: []
+  title: null

tests/test_cli.py

@@ -1,4 +1,6 @@
+import os
 from pathlib import Path
+from typing import List
 
 from click.testing import CliRunner
 
@@ -8,14 +10,11 @@
 import pytest
 
 
-# TOC_FILES = list(Path(__file__).parent.joinpath("_toc_files").glob("*.yml"))
-
-
 @pytest.fixture()
 def invoke_cli():
     """Run CLI and do standard checks."""
 
-    def _func(command, args, assert_exit: bool = True):
+    def _func(command, args: List[str], assert_exit: bool = True):
         runner = CliRunner()
         result = runner.invoke(command, args)
         if assert_exit:
@@ -26,11 +25,11 @@ def _func(command, args, assert_exit: bool = True):
 
 
 def test_version(invoke_cli):
-    result = invoke_cli(main, "--version")
+    result = invoke_cli(main, ["--version"])
     assert __version__ in result.output
 
 
 def test_parse_toc(invoke_cli):
-    path = Path(__file__).parent.joinpath("_toc_files", "basic.yml").resolve()
-    result = invoke_cli(parse_toc, str(path))
+    path = os.path.abspath(Path(__file__).parent.joinpath("_toc_files", "basic.yml"))
+    result = invoke_cli(parse_toc, [path])
     assert "intro" in result.output

tests/test_tools.py

@@ -12,5 +12,5 @@
 )
 def test_file_to_sitemap(path: Path, tmp_path: Path, data_regression):
     create_site_from_toc(path, root_path=tmp_path)
-    file_list = [str(p.relative_to(tmp_path)) for p in tmp_path.glob("**/*")]
+    file_list = [p.relative_to(tmp_path).as_posix() for p in tmp_path.glob("**/*")]
     data_regression.check(sorted(file_list))

tests/test_tools/test_file_to_sitemap_basic_.yml

@@ -2,5 +2,6 @@
 - doc1.rst
 - doc2.rst
 - doc3.rst
-- doc4.rst
 - intro.rst
+- subfolder
+- subfolder/doc4.rst