add rtd

.gitignore

@@ -25,12 +25,19 @@ gradle-app.setting
 .gradletasknamecache
 # gradle/wrapper/gradle-wrapper.properties
 
+sample
+docs/venv
+/docs/_build/
+
 ## VSCode Bullshit
 .classpath
 .project
 .settings
 
 *.pyc
 
+
+
 !test/resources/csse2002/lib/hamcrest-core-1.3.jar
-!test/resources/csse2002/lib/junit-4.12.jar
+!test/resources/csse2002/lib/junit-4.12.jar
+

docs/.python-version

@@ -0,0 +1 @@
+3.8.2

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/style.css

@@ -0,0 +1,3 @@
+.wy-side-nav-search {
+    background-color: #343030;
+}

docs/conf.py

@@ -0,0 +1,67 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Chalkbox'
+copyright = '2020, Brae Webb, Emily Bennett, Ella de Lore, Max Miller, Evan Hughes & Nicholas Lambourne'
+author = 'Brae Webb, Emily Bennett, Ella de Lore, Max Miller, Evan Hughes & Nicholas Lambourne'
+master_doc = 'index'
+
+# The full version, including alpha/beta/rc tags
+release = '3.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['recommonmark',
+              'sphinx.ext.autodoc',
+              'sphinx.ext.coverage',
+              'sphinx_autodoc_typehints']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+html_logo = '_static/images/logo/chalkbox.png'
+html_favicon = '_static/images/logo/chalkbox-small.png'
+html_theme_options = {
+    'logo_only': True,
+}
+github_url = 'https://github.com/uqtools/quickscope'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+html_css_files = [
+    'style.css',
+]

docs/guides/guides.rst

@@ -0,0 +1,11 @@
+Guides
+======
+
+Guides for course coordinators using Chalkbox.
+
+.. toctree::
+   :glob:
+   :caption: Guides:
+
+
+   creating-an-engine

docs/index.rst

@@ -0,0 +1,22 @@
+.. Chalkbox documentation master file, created by
+   sphinx-quickstart on Tue Oct 20 07:40:16 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Chalkbox's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+   guides/guides
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>2.1
+sphinx-autodoc-typehints<1.11.0
+sphinx-rtd-theme
+recommonmark