Add config files for environment, mkdocs, and gh actions.

Author: ericmjl

.github/workflows/docs.yaml

@@ -0,0 +1,79 @@
+# Publish documentation
+name: documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    # https://github.com/marketplace/actions/setup-miniconda#use-a-default-shell
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # See: https://github.com/marketplace/actions/setup-miniconda
+      - name: Setup miniconda
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          miniforge-variant: Mambaforge
+          environment-file: environment.yml
+          use-mamba: true
+
+      - name: Install pyjviz
+        # use editable mode to avoid _pytest.pathlib.ImportPathMismatchError
+        run: pip install -e .
+
+      - name: Build docs
+        run: mkdocs build
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: website
+          path: site/
+
+      - name: Test docs
+        run: pytest -m "documentation"
+
+      - name: Docs preview
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: nwtgck/[email protected]
+        with:
+          publish-dir: "./site"
+          production-deploy: false
+          github-token: ${{ secrets.GHPAGES_TOKEN }}
+          deploy-message: "Deploy from GitHub Actions"
+          enable-pull-request-comment: true
+          enable-commit-comment: false
+          overwrites-pull-request-comment: true
+          alias: deploy-preview-${{ github.event.number }}
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 1
+
+      - name: Deploy website
+        if: ${{ github.event_name == 'push' }}
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          # https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-set-personal-access-token-personal_token
+          personal_token: ${{ secrets.GHPAGES_TOKEN }}
+          publish_dir: ./site/
+          publish_branch: gh-pages
+          # destination_dir: manuscript
+          allow_empty_commit: false
+          keep_files: false
+          force_orphan: true
+          enable_jekyll: false
+          disable_nojekyll: false

environment.yml

@@ -0,0 +1,15 @@
+name: pyjviz
+channels:
+  - conda-forge
+dependencies:
+  - python=3.9
+  - rdflib
+  - graphviz
+  - python-graphviz
+  - pandas
+  - pandas-flavor
+  - black
+  - mypy
+  - flake8
+  - mkdocs
+  - pre-commit

mkdocs.yaml

@@ -0,0 +1,59 @@
+# Project information
+site_name: pyjviz documentation
+site_url: https://pyjanitor-devs.github.io/pyjviz
+site_description: >-
+  Python implementation of the R package janitor
+
+# Repository
+repo_name: "pyjanitor-devs/pyjviz"
+repo_url: "https://github.com/pyjanitor-devs/pyjviz"
+
+# Configuration
+docs_dir: docs/
+watch:
+  - pyjviz/
+
+theme:
+  name: "material"
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: "blue grey"
+      accent: "light blue"
+  icon:
+    logo: "fontawesome/solid/book"
+  features:
+    - navigation.instant
+    # - navigation.tabs
+    - navigation.top
+    - toc.follow
+    - content.code.copy
+  language: en
+
+# Page tree
+# We customize the navigation by hand to control the order
+# in which pages show up.
+nav:
+  - Home: index.md
+
+plugins:
+  - search
+  - autorefs
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          options:
+            docstring_style: "google"
+            docstring_options:
+              trim_doctest_flags: true
+            show_root_toc_entry: false
+            show_submodules: true
+            show_source: true
+
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight:
+      use_pygments: true
+  - pymdownx.inlinehilite
+  - pymdownx.superfences