Add automated documentation

.github/ISSUE_TEMPLATE/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contribution Guidelines
+
+This project follows the [DataJoint Contribution Guidelines](https://docs.datajoint.io/python/community/02-Contribute.html). Please reference the link for more full details.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+## Bug Report
+
+### Description
+A clear and concise description of what is the overall operation that is intended to be performed that resulted in an error.
+
+### Reproducibility
+Include:
+- OS (WIN | MACOS | Linux)
+- Pharus Version
+- MySQL Version
+- MySQL Deployment Strategy (local-native | local-docker | remote)
+- Minimum number of steps to reliably reproduce the issue
+- Complete error stack as a result of evaluating the above steps
+
+### Expected Behavior
+A clear and concise description of what you expected to happen.
+
+### Screenshots
+If applicable, add screenshots to help explain your problem.
+
+### Additional Research and Context
+Add any additional research or context that was conducted in creating this report.
+
+For example:
+- Related GitHub issues and PR's either within this repository or in other relevant repositories.
+- Specific links to specific lines or a focus within source code.
+- Relevant summary of Maintainers development meetings, milestones, projects, etc.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: DataJoint Contribution Guideline
+    url: https://docs.datajoint.io/python/community/02-Contribute.html
+    about: Please make sure to review the DataJoint Contribution Guideline

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,45 @@
+---
+name: Feature request
+about: Suggest an idea for a new feature
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+## Feature Request
+
+### Problem
+A clear and concise description how this idea has manifested and the context. Elaborate on the need for this feature and/or what could be improved. Ex. I'm always frustrated when [...]
+
+### Requirements
+A clear and concise description of the requirements to satisfy the new feature. Detail what you expect from a successful implementation of the feature. Ex. When using this feature, it should [...]
+
+### Justification
+Provide the key benefits in making this a supported feature. Ex. Adding support for this feature would ensure [...]
+
+### Alternative Considerations
+Do you currently have a work-around for this? Provide any alternative solutions or features you've considered.
+
+### Related Errors
+Add any errors as a direct result of not exposing this feature.
+
+Please include steps to reproduce provided errors as follows:
+- OS (WIN | MACOS | Linux)
+- Pharus Version
+- MySQL Version
+- MySQL Deployment Strategy (local-native | local-docker | remote)
+- Minimum number of steps to reliably reproduce the issue
+- Complete error stack as a result of evaluating the above steps
+
+### Screenshots
+If applicable, add screenshots to help explain your feature.
+
+### Additional Research and Context
+Add any additional research or context that was conducted in creating this feature request.
+
+For example:
+- Related GitHub issues and PR's either within this repository or in other relevant repositories.
+- Specific links to specific lines or a focus within source code.
+- Relevant summary of Maintainers development meetings, milestones, projects, etc.
+- Any additional supplemental web references or links that would further justify this feature request.

.github/workflows/development.yaml

@@ -27,6 +27,29 @@ jobs:
           echo "BODY=${BODY}"
           echo "PRERELEASE=${PRERELEASE}"
           echo "DRAFT=${DRAFT}"
+  build-docs:
+    needs: test-changelog
+    runs-on: ubuntu-latest
+    env:
+      DOCKER_CLIENT_TIMEOUT: "120"
+      COMPOSE_HTTP_TIMEOUT: "120"
+      PY_VER: "3.8"
+      IMAGE: "djtest"
+      DISTRO: "alpine"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Compile docs static artifacts
+        run: |
+          export PHARUS_VERSION=$(cat pharus/version.py | tail -1 | awk -F\' '{print $2}')
+          export HOST_UID=$(id -u)
+          docker-compose -f docker-compose-docs.yaml up --exit-code-from pharus --build
+          echo "PHARUS_VERSION=${PHARUS_VERSION}" >> $GITHUB_ENV
+      - name: Add docs static artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: docs-static-pharus-${{env.PHARUS_VERSION}}
+          path: docs/_build/html
+          retention-days: 1
   build:
     needs: test-changelog
     runs-on: ubuntu-latest
@@ -220,39 +243,51 @@ jobs:
           asset_name: "image-pharus-${{env.PHARUS_VERSION}}-py${{matrix.py_ver}}-\
             ${{matrix.distro}}.tar.gz"
           asset_content_type: application/gzip
-  # publish-docs:
-  #   if: github.event_name == 'push' && github.ref == 'refs/heads/master'
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v1
-  #     - name: Build docs
-  #       uses: ammaraskar/sphinx-action@master
-  #       with:
-  #         docs-folder: "docs/"
-  #     # - name: Upload docs artifact
-  #     #   uses: actions/upload-artifact@v1
-  #     #   with:
-  #     #     name: docs-html
-  #     #     path: docs/_build/html/
-  #     #     retention-days: 1
-  #     - name: Commit documentation changes
-  #       run: |
-  #         git clone https://github.com/${GITHUB_REPOSITORY}.git \
-  #             --branch gh-pages --single-branch gh-pages
-  #         rm -R gh-pages/*
-  #         cp -r docs/_build/html/* gh-pages/
-  #         cp .gitignore gh-pages/
-  #         touch gh-pages/.nojekyll
-  #         cd gh-pages
-  #         git config --local user.email "[email protected]"
-  #         git config --local user.name "GitHub Action"
-  #         git add . --all
-  #         git commit -m "Update documentation" -a || true
-  #         # The above command will fail if no changes were present, so we ignore
-  #         # the return code.
-  #     - name: Push changes
-  #       uses: ad-m/github-push-action@master
-  #       with:
-  #         branch: gh-pages
-  #         directory: gh-pages
-  #         github_token: ${{secrets.GITHUB_TOKEN}}
+  publish-docs:
+    if: github.event_name == 'push'
+    needs: publish-release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Determine package version
+        run: |
+          PHARUS_VERSION=$(cat pharus/version.py | tail -1 | awk -F\' '{print $2}')
+          echo "PHARUS_VERSION=${PHARUS_VERSION}" >> $GITHUB_ENV
+      - name: Fetch docs static artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: docs-static-pharus-${{env.PHARUS_VERSION}}
+          path: docs/_build/html
+      - name: Commit documentation changes
+        run: |
+          git clone https://github.com/${GITHUB_REPOSITORY}.git \
+              --branch gh-pages --single-branch gh-pages
+          rm -R gh-pages/*
+          cp -r docs/_build/html/* gh-pages/
+          cp .gitignore gh-pages/
+          touch gh-pages/.nojekyll
+          cd gh-pages
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add . --all
+          git commit -m "Update documentation" -a || true
+          # The above command will fail if no changes were present, so we ignore
+          # the return code.
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          branch: gh-pages
+          directory: gh-pages
+          github_token: ${{secrets.GITHUB_TOKEN}}
+      - name: Compress docs static site artifacts
+        run: zip -r docs-static-pharus-${PHARUS_VERSION}.zip docs/_build/html
+      - name: Upload docs static site to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        with:
+          upload_url: ${{needs.publish-release.outputs.release_upload_url}}
+          asset_path: docs-static-pharus-${PHARUS_VERSION}.zip
+          asset_name: docs-static-pharus-${PHARUS_VERSION}.zip
+          asset_content_type: application/zip
+          # fail_on_unmatched_files: true

.gitignore

@@ -5,4 +5,6 @@ docker-compose.y*ml
 .coverage
 *.egg-info
 dist
-build
+build
+docs/_build
+*.tar.gz

CHANGELOG.md

@@ -2,11 +2,20 @@
 
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
-## [Unreleased]
+## [0.1.0b1] - 2021-03-11
 
 ### Fixed
 - Fixed behavior where using list_table with a nonexistent schema_name creates it instead of returning an error message (#65) PR #63
 
+### Changed
+- Contribution policy to follow directly the general DataJoint Contribution Guideline. (#91) PR #94
+
+### Added
+- Issue templates for bug reports and enhancement requests. PR #94
+- Docker environment for documentation build. (#92) PR #94
+- Add Sphinx-based documentation source and fix parsing issues. (#92) PR #94
+- GitHub Actions automation that publishes on release new docs to release and GitHub Pages. (#92) PR #94
+
 ## [0.1.0b0] - 2021-02-26
 
 ### Security
@@ -41,6 +50,6 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 - Support for DataJoint attribute types: `varchar`, `int`, `float`, `datetime`, `date`, `time`, `decimal`, `uuid`.
 - Check dependency utility to determine child table references.
 
-[Unreleased]: https://github.com/datajoint/pharus/compare/0.1.0b0...HEAD
+[0.1.0b1]: https://github.com/datajoint/pharus/compare/0.1.0b0...0.1.0b1
 [0.1.0b0]: https://github.com/datajoint/pharus/compare/0.1.0a5...0.1.0b0
 [0.1.0a5]: https://github.com/datajoint/pharus/releases/tag/0.1.0a5

Dockerfile

@@ -2,7 +2,7 @@ ARG PY_VER
 ARG DISTRO
 ARG IMAGE
 FROM datajoint/${IMAGE}:py${PY_VER}-${DISTRO}
-COPY --chown=dja:anaconda ./README.md ./requirements.txt ./setup.py \
+COPY --chown=dja:anaconda ./README.rst ./requirements.txt ./setup.py \
     /main/
 COPY --chown=dja:anaconda ./pharus/*.py /main/pharus/
 RUN \