add sphinx build stuff

Author: Nathan Sprague

doc/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)

doc/conf.py

@@ -0,0 +1,20 @@
+import os
+import sys
+
+html_static_path = []
+
+# enable autodoc to load local modules
+sys.path.insert(0, os.path.abspath(".."))
+
+project = "JMU Python Gradescope Utils"
+copyright = "2020"
+author = "JMU People"
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx",'sphinx.ext.napoleon' ]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+templates_path = ["_templates"]
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None)
+}
+html_theme_options = {"nosidebar": True}

doc/coverage_utils.rst

@@ -0,0 +1,15 @@
+.. JMU Python Gradescope Utilities documentation master file, created by
+   sphinx-quickstart on Wed Jun  1 13:47:46 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+jmu_gradescope_utils.coverage_utils
+===========================================================
+
+
+.. automodule:: jmu_gradescope_utils.coverage_utils
+   :members:
+   :private-members:
+   :undoc-members:
+
+

doc/index.rst

@@ -0,0 +1,23 @@
+.. JMU Python Gradescope Utilities documentation master file, created by
+   sphinx-quickstart on Wed Jun  1 13:47:46 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to JMU Python Gradescope Utilities's documentation!
+===========================================================
+
+.. toctree::
+   jmu_test_case
+   utils
+   coverage_utils
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/jmu_test_case.rst

@@ -0,0 +1,26 @@
+.. JMU Python Gradescope Utilities documentation master file, created by
+   sphinx-quickstart on Wed Jun  1 13:47:46 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+JmuTestCase
+===========================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. automodule:: jmu_gradescope_utils.jmu_test_case
+   :members:
+   :private-members:
+   :undoc-members:
+
+.. automodule:: jmu_gradescope_utils.utils
+   :members:
+   :private-members:
+   :undoc-members:
+
+.. automodule:: jmu_gradescope_utils.coverage_utils
+   :members:
+   :private-members:
+   :undoc-members:

doc/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.https://www.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

doc/utils.rst

@@ -0,0 +1,16 @@
+.. JMU Python Gradescope Utilities documentation master file, created by
+   sphinx-quickstart on Wed Jun  1 13:47:46 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+jmu_gradescope_utils.utils
+===========================================================
+
+
+.. automodule:: jmu_gradescope_utils.utils
+   :members:
+   :private-members:
+   :undoc-members:
+
+
+