Merge pull request #3 from executablebooks/testing2

Author: choldgraf

.github/workflows/tests.yml

@@ -22,10 +22,31 @@ jobs:
       run: |
         pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
 
+  tests:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[testing]
+    - name: Run pytest
+      run: |
+        pytest
+
   publish:
 
     name: Publish to PyPi
-    needs: [pre-commit]
+    needs: [pre-commit, tests]
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -127,3 +127,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+.vscode/

README.md

@@ -1,25 +1,35 @@
 # sphinx-panels
 
-A sphinx extension for creating panels in a grid layout.
+[![Doc Status][rtd-badge]][rtd-link]
+[![Code style: black][black-badge]][black-link]
+[![PyPI][pypi-badge]][pypi-link]
 
-This directive creates panels of content in a 2 x N layout.
-The panels are separated by three or more ``-``
+A sphinx extension for creating panels in a grid layout.
+utilising both the bootstrap 4
+[grid system](https://getbootstrap.com/docs/4.0/layout/grid/),
+and [cards layout](https://getbootstrap.com/docs/4.0/components/card/).
 
 ```rst
 .. panels::
-    :centred:
 
     Content of the top-left panel
 
-    ---
+    ...
 
     Content of the top-right panel
 
-    ---
+    ...
 
     Content of the bottom-left panel
 
-    ---
+    ...
 
     Content of the bottom-right panel
 ```
+
+[rtd-badge]: https://readthedocs.org/projects/sphinx-panels/badge/?version=latest
+[rtd-link]: https://sphinx-panels.readthedocs.io/en/latest/?badge=latest
+[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
+[black-link]: https://github.com/ambv/black
+[pypi-badge]: https://img.shields.io/pypi/v/sphinx-panels.svg
+[pypi-link]: https://pypi.org/project/sphinx-panels

docs/Makefile

@@ -18,3 +18,6 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -r $(BUILDDIR)