Add preliminary docs setup

.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v2
+
+      - uses: actions/cache@v2
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ hashFiles('dev-requirements.txt') }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install -e '.[dev]'
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CONFIG_FILE: mkdocs.yml
+          EXTRA_PACKAGES: build-base

CONTRIBUTING.md

@@ -16,6 +16,7 @@ If submitting a pull request:
    * Follow [PEP8](https://www.python.org/dev/peps/pep-0008/) and [PEP257](https://www.python.org/dev/peps/pep-0257/). These will be required in the CI builds.
    * Don't repeat code.
    * Cover the code with tests.
+   * Use [Google style docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) for any code documentation you add.
 
 ## Developing helpers
 
@@ -27,3 +28,8 @@ To develop a helper you should follow the documentation [here](https://github.co
  * A fixture which demonstrates your use case in the [fixtures directory](https://github.com/iiif-prezi/iiif-prezi3/tree/main/tests/fixtures).
 
 Please submit your pull request to this repository and one of the library committers will merge it into the main if it fits these requirements.
+
+
+## Docs
+
+To build and view the documentation locally, install requirements with `pip install -e '.[docs]'` and then run `mkdocs serve`.

docs/README.md

@@ -0,0 +1 @@
+../README.md

docs/code.md

@@ -0,0 +1,3 @@
+# Code reference
+
+::: iiif_prezi3

mkdocs.yml

@@ -0,0 +1,17 @@
+site_name: iiif-prezi3
+
+nav:
+    - 'Getting started':
+        - 'Using iiifprezi3 without helper methods': 'getting-started-using-iiifprezi3-without-helpermethods.md'
+        - 'add-reference-to-manifest-inside-a-collection.md'
+    - Technical:
+        - 'generate-schema.md'
+        - 'write-helper-method.md'
+        - code.md
+
+theme:
+  name: material
+
+plugins:
+  - search
+  - mkdocstrings

setup.py

@@ -16,6 +16,12 @@
     "pydantic"
 ]
 
+DOCS_REQUIREMENTS = [
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocstrings",
+]
+
 # Setting up
 setup(
     name='iiif-prezi3',
@@ -46,4 +52,7 @@
     url='https://github.com/iiif-prezi/iiif-prezi3',
     license='LICENSE',
     install_requires=REQUIREMENTS,
+     extras_require={
+        "docs": DOCS_REQUIREMENTS,
+    },
 )