Merge pull request #103 from asmeurer/docs

HTML documentation

Author: asmeurer

Diff for: .github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Docs
+on: [push, pull_request]
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    environment:
+      name: docs-build-and-deploy
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install Dependencies
+        run: |
+          python -m pip install -r docs/requirements.txt
+
+      - name: Build Docs
+        run: |
+          cd docs
+          make html
+
+      # Note, the gh-pages deployment requires setting up a SSH deploy key.
+      # See
+      # https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          folder: docs/_build/html
+          ssh-key: ${{ secrets.DEPLOY_KEY }}
+          force: no

Diff for: CONTRIBUTING.md

@@ -0,0 +1,7 @@
+Contributions to array-api-compat are welcome, so long as they are [in
+scope](https://data-apis.org/array-api-compat/index.html#scope).
+
+Contributors are encouraged to read through the [development
+notes](https://data-apis.org/array-api-compat/dev/index.html) for the package
+to get full context on some of the design decisions and implementation
+details used in the codebase.