Add macOS to CI (#35)

* Updated docs to show that macOS is supported

.github/workflows/gh-ci.yaml

@@ -42,7 +42,7 @@ jobs:
         fail-fast: false
         matrix:
           # os: [macOS-latest, ubuntu-latest, windows-latest]
-          os: [ubuntu-latest]
+          os: [ubuntu-latest, macOS-latest]
           python-version: ["3.9", "3.10", "3.11"]
           mdanalysis-version: ["latest", "develop"]
 

CHANGELOG.md

@@ -23,6 +23,7 @@ The rules for this file:
 - ianmkenney
 
 ### Added
+- mdahole2 confirmed to work on macOS and is now included in CI (PR #35)
 <!-- New added features -->
 
 ### Fixed

README.md

@@ -13,13 +13,15 @@ mdahole2 is bound by a [Code of Conduct](https://github.com/MDAnalysis/hole2-mda
 
 ### Installation
 
-To build mdahole2 from source,
+To build `mdahole2` from source,
 we highly recommend using virtual environments.
 If possible, we strongly recommend that you use
 [Anaconda](https://docs.conda.io/en/latest/) as your package manager.
 Below we provide instructions both for `conda` and
 for `pip`.
 
+Note that `mdahole2` is only supported on Linux and macOS.
+
 #### With conda
 
 Ensure that you have [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed.

docs/source/getting_started.rst

@@ -1,7 +1,8 @@
 Getting Started
 ===============
 
-This page details how to get started with `mdahole2`.
+This page details how to get started with ``mdahole2``.
+Note that ``mdahole2`` is only supported on Linux or macOS.
 
 Documentation
 ~~~~~~~~~~~~~
@@ -13,7 +14,7 @@ Documentation is hosted on `GitHub Pages`_.
 Download source code
 ~~~~~~~~~~~~~~~~~~~~
 
-The `mdahole2` source code is hosted on GitHub_ and can be downloaded with
+The ``mdahole2`` source code is hosted on GitHub_ and can be downloaded with
 
 .. code:: bash
 
@@ -30,8 +31,8 @@ with an SSH key, or with
 Build and installation
 ~~~~~~~~~~~~~~~~~~~~~~
 
-`mdahole2` is currently only installable from source (although hosting on conda-forge is planned).
-As such `conda-build` is required. To download this utility, invoke:
+``mdahole2`` is currently only installable from source (although hosting on conda-forge is planned).
+As such ``conda-build`` is required. To download this utility, invoke:
 
 .. code:: bash
 

setup.py

@@ -53,7 +53,7 @@
         "mdanalysis>=2.0.0",
     ],
     # Additional entries you may want simply uncomment the lines you want and fill in the data
-    # url='mdahole2.readthedocs.io/en/latest/',  # Website
+    url='https://www.mdanalysis.org/hole2-mdakit',
     # platforms=['Linux',
     #            'Mac OS-X',
     #            'Unix',