JOB-85 Moved docs into repo

jobbergate-docs/.gitignore

@@ -0,0 +1,3 @@
+# Git ignore for main branch and topic branches. Must be revised for docs branch
+
+build/*

jobbergate-docs/CHANGELOG.rst

@@ -0,0 +1,36 @@
+.. figure:: /src/_images/logo.png?raw=true
+   :alt: Logo
+   :align: center
+   :width: 80px
+
+   An Omnivector Solutions initiative
+
+==========================
+ Jobbergate Documentation
+==========================
+
+This repository contains the source for the Jobbergate documentation.
+
+It uses [sphinx](https://www.sphinx-doc.org/en/master/) to render html pages from
+the sourc ReStructuredText documents.
+
+
+Build
+=====
+
+To build the documentation website, run the following command::
+
+    $ make docs
+
+
+Other Commands
+==============
+
+To lint the python files in the ``src`` directory, run::
+
+    $ make lint
+
+
+To clean up build artifacts, run::
+
+    $ make clean

jobbergate-docs/Makefile

@@ -0,0 +1,43 @@
+# SETTINGS
+# Use one shell for all commands in a target recipe
+.ONESHELL:
+.DEFAULT_GOAL:=help
+SHELL:=/bin/bash
+
+.PHONY: install
+install:
+	poetry install
+
+.PHONY: lint
+lint: install
+	poetry run black --check src
+	poetry run isort --check src
+	poetry run flake8 --max-line-length=120 --max-complexity=40 src
+
+.PHONY: qa
+qa: lint
+	echo "All tests pass! Ready for deployment"
+
+.PHONY: format
+format: install
+	poetry run black src
+	poetry run isort src
+
+.PHONY: docs
+docs: install
+	poetry run sphinx-build src/ build/
+
+.PHONY: clean
+clean:
+	@find . -iname '*.pyc' -delete
+	@find . -iname '*.pyo' -delete
+	@find . -iname '*~' -delete
+	@find . -iname '*.swp' -delete
+	@find . -iname '__pycache__' -delete
+	@rm -fr build/
+	@rm -fr dist/
+	@rm -fr *.egg-info
+
+.PHONY: help
+help: # Display target comments in 'make help'
+	grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

jobbergate-docs/README.rst

@@ -0,0 +1,36 @@
+.. figure:: /src/images/logo.png?raw=true
+   :alt: Logo
+   :align: center
+   :width: 80px
+
+   An Omnivector Solutions initiative
+
+===========================
+ Jobbergatge Documentation
+===========================
+
+This repository contains the source for the Jobbergate Documentation page.
+
+It is built using [sphinx](https://www.sphinx-doc.org/en/master/) to render the source into
+a static website.
+
+
+Build the Docs
+==============
+
+To build the documentation static site, run the following command::
+
+    $ make docs
+
+
+Other Commands
+==============
+
+To lint the python files in the ``src`` directory, run::
+
+    $ make lint
+
+
+To clean up build artifacts, run::
+
+    $ make clean