Windows support (#22)

Author: cluttrdev

.github/workflows/ci.yml

@@ -3,7 +3,8 @@ name: CI
 on:
   pull_request:
   push:
-    branches: master
+    branches: 
+    - master
     tags:
     - 'v*'
 
@@ -14,6 +15,8 @@ jobs:
       matrix:
         python-version:
         - 3.6
+        - 3.7
+        - 3.8
         - 3.9
         runs-on:
         - ubuntu-latest
@@ -31,8 +34,32 @@ jobs:
 
     - name: Test package
       run: python -m pytest --forked
+      
+  checks_windows:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+        - 3.8
+        - 3.9
+        runs-on:
+        - windows-latest
+    runs-on: ${{ matrix.runs-on }}
+    name: Test • 🐍 ${{ matrix.python-version }} • ${{matrix.runs-on}}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
 
+    - name: Install package
+      run: python -m pip install .[test]
 
+    - name: Test package
+      env:
+        LIBCLANG_PATH: C:\msys64\mingw64\bin\libclang.dll
+      run: python -m pytest -n2
+  
   dist:
     runs-on: ubuntu-latest
     name: Build distribution

README.md

@@ -76,8 +76,8 @@ py::class_<MyClass>(m, "MyClass", DOC(MyClass))
 
 ## Limitations
 
-This tool supports Linux and macOS and requires Clang/LLVM to be installed. It
-has never been used on Windows and will likely require adaptations.
+This tool supports Linux and macOS for Python versions 3.6 to 3.9. On Windows you at least need Python version 3.8.
+Also, it requires Clang/LLVM to be installed.
 
 
 ## Testing
@@ -94,5 +94,5 @@ python3 -m pip install .
 
 And execute the tests (forked)
 ```
-python3 -m pip pytest --forked
-```
+python3 -m pytest --forked
+```

pybind11_mkdoc/mkdoc_lib.py

@@ -12,6 +12,8 @@
 import re
 import textwrap
 
+import ctypes.util
+
 from clang import cindex
 from clang.cindex import CursorKind
 from collections import OrderedDict
@@ -272,6 +274,18 @@ def read_args(args):
             sysroot_dir = os.path.join(sdk_dir, next(os.walk(sdk_dir))[1][0])
             parameters.append('-isysroot')
             parameters.append(sysroot_dir)
+    elif platform.system() == 'Windows':
+        if 'LIBCLANG_PATH' in os.environ:
+            library_file = os.environ['LIBCLANG_PATH']
+            if os.path.isfile(library_file):
+                cindex.Config.set_library_file(library_file)
+            else:
+                raise FileNotFoundError("Failed to find libclang.dll! "
+                                        "Set the LIBCLANG_PATH environment variable to provide a path to it.")
+        else:
+            library_file = ctypes.util.find_library('libclang.dll')
+            if library_file is not None:
+                cindex.Config.set_library_file(library_file)
     elif platform.system() == 'Linux':
         # cython.util.find_library does not find `libclang` for all clang
         # versions and distributions. LLVM switched to a monolithical setup