remove backend docs dir (#325)

* remove backend docs dir

* remove reference to gone dir

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>

docs/conf.py

@@ -6,6 +6,10 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+# note that backend had autoapi hooked up at one point to generate python API docs.
+# if we want that again some day, here were the docs in that sub-folder docs dir:
+#   https://github.com/sartography/spiff-arena/blob/d9b303db782b1004a818c426283e9cfbc5ed0ec7/spiffworkflow-backend/docs/conf.py
+
 project = 'SpiffWorkflow'
 copyright = '2023, Sartography'
 author = 'Sartography' # Very ok to add your name here.
@@ -44,4 +48,4 @@ html_theme_options = {
 }
 
 
-html_css_files = ["custom.css"]
+html_css_files = ["custom.css"]

spiffworkflow-backend/docs/codeofconduct.rst

@@ -1 +0,0 @@
-.. include:: ../CODE_OF_CONDUCT.rst

spiffworkflow-backend/docs/conf.py

@@ -1,16 +0,0 @@
-"""Sphinx configuration."""
-from datetime import datetime
-
-project = "Spiffworkflow Backend"
-author = "Sartography"
-copyright = f"{datetime.now().year}, {author}"
-extensions = [
-    "sphinx.ext.napoleon",
-    "autoapi.extension",
-    "sphinx_click",
-]
-
-# https://github.com/readthedocs/sphinx-autoapi
-autoapi_type = "python"
-autoapi_dirs = ["../src"]
-html_theme = "furo"

spiffworkflow-backend/docs/contributing.rst

@@ -1,4 +0,0 @@
-.. include:: ../CONTRIBUTING.rst
-   :end-before: github-only
-
-.. _Code of Conduct: codeofconduct.html

spiffworkflow-backend/docs/index.rst

@@ -1,16 +0,0 @@
-.. include:: ../README.rst
-   :end-before: github-only
-
-.. _Contributor Guide: contributing.html
-.. _Usage: usage.html
-
-.. toctree::
-   :hidden:
-   :maxdepth: 1
-
-   usage
-   reference
-   contributing
-   Code of Conduct <codeofconduct>
-   License <license>
-   Changelog <https://github.com/sartography/spiffworkflow-backend/releases>

spiffworkflow-backend/docs/license.rst

@@ -1 +0,0 @@
-.. include:: ../LICENSE.rst

spiffworkflow-backend/docs/reference.rst

@@ -1,9 +0,0 @@
-Reference
-=========
-
-
-spiffworkflow_backend
-----------
-
-.. automodule:: spiffworkflow_backend
-   :members:

spiffworkflow-backend/docs/requirements.txt

@@ -1,3 +0,0 @@
-furo==2023.5.20
-sphinx==5.3.0
-sphinx-click==4.4.0

spiffworkflow-backend/docs/usage.rst

@@ -1,6 +0,0 @@
-Usage
-=====
-
-.. click:: spiffworkflow_backend.__main__:main
-   :prog: spiffworkflow-backend
-   :nested: full

spiffworkflow-backend/noxfile.py

@@ -138,7 +138,7 @@ def safety(session: Session) -> None:
 @session(python=python_versions)
 def mypy(session: Session) -> None:
     """Type-check using mypy."""
-    args = session.posargs or ["src", "tests", "docs/conf.py"]
+    args = session.posargs or ["src", "tests"]
     session.install(".")
     session.install("mypy")
     session.run("mypy", *args)