BLD: Build docs and test if package is installable during CI (#162)

Co-authored-by: Joe Jevnik <[email protected]>

Author: gerrymanoim

.github/workflows/main.yml

@@ -57,11 +57,11 @@ jobs:
     - name: Install c++ dependencies (ubuntu)
       if: startsWith(matrix.os, 'ubuntu')
       run: |
-        sudo apt-get -y install libpcre2-dev libsparsehash-dev
+        sudo apt-get -y install libpcre2-dev libsparsehash-dev doxygen
     - name: Install c++ dependencies (macos)
       if: startsWith(matrix.os, 'macos')
       run: |
-        brew install pcre2 google-sparsehash
+        brew install pcre2 google-sparsehash doxygen
     - name: Set llvm related envvars (macos)
       if: startsWith(matrix.os, 'macos')
       run: |
@@ -83,3 +83,14 @@ jobs:
     - name: Run the tests
       run: |
         make -j2 test
+    - name: Check that we can still install
+      run: |
+        pip install .
+    - name: Check that docs can be built
+      # note we don't build this on macOS because the GHA python is built with
+      # the wrong version of macOS, confusing clang.
+      # See: https://github.com/actions/virtual-environments/issues/696
+      if: startsWith(matrix.os, 'ubuntu')
+      run: |
+        pip install sphinx sphinx_rtd_theme breathe ipython
+        make docs

docs/source/tutorial.rst

@@ -29,7 +29,7 @@ A great way to use ``libpy`` is to write the code that needs to be fast in C++ a
 
 .. ipython:: python
 
-  scalar_functions.monte_carlo_pi(10_000_000)
+  scalar_functions.monte_carlo_pi(10000000)
 
 Of course, we can build C++ functions that support all the features of regular Python functions.
 

docs/source/tutorial/setup.py

@@ -27,6 +27,7 @@ def extension(*args, **kwargs):
         **kwargs
     )
 
+
 install_requires = [
     'setuptools',
     'libpy',

libpy/__init__.py

@@ -12,17 +12,17 @@ class VersionInfo(ctypes.Structure):
     _fields_ = [
         ('major', ctypes.c_int),
         ('minor', ctypes.c_int),
-        ('patch', ctypes.c_int),
+        ('micro', ctypes.c_int),
     ]
 
     def __repr__(self):
         return (
             '{type_name}(major={0.major},'
-            ' minor={0.minor}, patch={0.patch})'
+            ' minor={0.minor}, patch={0.micro})'
         ).format(self, type_name=type(self).__name__)
 
     def __str__(self):
-        return '{0.major}.{0.minor}.{0.patch}'.format(self)
+        return '{0.major}.{0.minor}.{0.micro}'.format(self)
 
 
 version_info = VersionInfo.in_dll(_so, 'libpy_abi_version')

libpy/build.py

@@ -7,6 +7,8 @@
 import setuptools
 import numpy as np
 
+import libpy
+
 
 def detect_compiler():
     p = subprocess.Popen(
@@ -113,6 +115,9 @@ class LibpyExtension(setuptools.Extension, object):
         '-fvisibility-inlines-hidden',
         '-DPY_MAJOR_VERSION=%d' % sys.version_info.major,
         '-DPY_MINOR_VERSION=%d' % sys.version_info.minor,
+        '-DLIBPY_MAJOR_VERSION=%d' % libpy.version_info.major,
+        '-DLIBPY_MINOR_VERSION=%d' % libpy.version_info.minor,
+        '-DLIBPY_MICRO_VERSION=%d' % libpy.version_info.micro,
     ]
 
     def __init__(self, *args, **kwargs):

setup.py

@@ -1,7 +1,9 @@
 import ast
 from distutils.command.build_py import build_py as _build_py
 import os
+import pathlib
 import shutil
+import stat
 
 from setuptools import setup
 
@@ -35,12 +37,14 @@ def run(self):
                 "Command {!r} failed with code {}".format(command, out)
             )
 
-        print(os.listdir('libpy'))
         shutil.copyfile(
             'libpy/libpy.so',
             os.path.join(self.build_lib, 'libpy', 'libpy.so'),
         )
 
+        p = pathlib.Path(self.build_lib) / 'libpy/_build-and-run'
+        p.chmod(p.stat().st_mode | stat.S_IEXEC)
+
 
 setup(
     name='libpy',
@@ -71,6 +75,11 @@ def run(self):
     install_requires=['numpy'],
     cmdclass={'build_py': build_py},
     package_data={
-        'libpy': ['include/**/*.h', '_build-and-run', '_detect-compiler.cc'],
+        'libpy': [
+            'include/libpy/*.h',
+            'include/libpy/detail/*.h',
+            '_build-and-run',
+            '_detect-compiler.cc',
+        ],
     },
 )