From 41ccb7d863e3103f5c0312365e8854bb3a96790f Mon Sep 17 00:00:00 2001 From: Kevin Burnett <18027+burnettk@users.noreply.github.com> Date: Mon, 12 Jun 2023 09:28:58 -0700 Subject: [PATCH] remove backend docs dir (#325) * remove backend docs dir * remove reference to gone dir --------- Co-authored-by: burnettk --- docs/conf.py | 6 +++++- spiffworkflow-backend/docs/codeofconduct.rst | 1 - spiffworkflow-backend/docs/conf.py | 16 ---------------- spiffworkflow-backend/docs/contributing.rst | 4 ---- spiffworkflow-backend/docs/index.rst | 16 ---------------- spiffworkflow-backend/docs/license.rst | 1 - spiffworkflow-backend/docs/reference.rst | 9 --------- spiffworkflow-backend/docs/requirements.txt | 3 --- spiffworkflow-backend/docs/usage.rst | 6 ------ spiffworkflow-backend/noxfile.py | 2 +- 10 files changed, 6 insertions(+), 58 deletions(-) delete mode 100644 spiffworkflow-backend/docs/codeofconduct.rst delete mode 100644 spiffworkflow-backend/docs/conf.py delete mode 100644 spiffworkflow-backend/docs/contributing.rst delete mode 100644 spiffworkflow-backend/docs/index.rst delete mode 100644 spiffworkflow-backend/docs/license.rst delete mode 100644 spiffworkflow-backend/docs/reference.rst delete mode 100644 spiffworkflow-backend/docs/requirements.txt delete mode 100644 spiffworkflow-backend/docs/usage.rst diff --git a/docs/conf.py b/docs/conf.py index d67508d2f..338d15085 100644 --- a/docs/conf.py +++ b/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"] \ No newline at end of file +html_css_files = ["custom.css"] diff --git a/spiffworkflow-backend/docs/codeofconduct.rst b/spiffworkflow-backend/docs/codeofconduct.rst deleted file mode 100644 index 96e0ba2f5..000000000 --- a/spiffworkflow-backend/docs/codeofconduct.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CODE_OF_CONDUCT.rst diff --git a/spiffworkflow-backend/docs/conf.py b/spiffworkflow-backend/docs/conf.py deleted file mode 100644 index 154f6d500..000000000 --- a/spiffworkflow-backend/docs/conf.py +++ /dev/null @@ -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" diff --git a/spiffworkflow-backend/docs/contributing.rst b/spiffworkflow-backend/docs/contributing.rst deleted file mode 100644 index c8670b6bb..000000000 --- a/spiffworkflow-backend/docs/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. include:: ../CONTRIBUTING.rst - :end-before: github-only - -.. _Code of Conduct: codeofconduct.html diff --git a/spiffworkflow-backend/docs/index.rst b/spiffworkflow-backend/docs/index.rst deleted file mode 100644 index 3a2ebb735..000000000 --- a/spiffworkflow-backend/docs/index.rst +++ /dev/null @@ -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 - License - Changelog diff --git a/spiffworkflow-backend/docs/license.rst b/spiffworkflow-backend/docs/license.rst deleted file mode 100644 index 68c5792f0..000000000 --- a/spiffworkflow-backend/docs/license.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../LICENSE.rst diff --git a/spiffworkflow-backend/docs/reference.rst b/spiffworkflow-backend/docs/reference.rst deleted file mode 100644 index 0529ca1fd..000000000 --- a/spiffworkflow-backend/docs/reference.rst +++ /dev/null @@ -1,9 +0,0 @@ -Reference -========= - - -spiffworkflow_backend ----------- - -.. automodule:: spiffworkflow_backend - :members: diff --git a/spiffworkflow-backend/docs/requirements.txt b/spiffworkflow-backend/docs/requirements.txt deleted file mode 100644 index ea8c3552b..000000000 --- a/spiffworkflow-backend/docs/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -furo==2023.5.20 -sphinx==5.3.0 -sphinx-click==4.4.0 diff --git a/spiffworkflow-backend/docs/usage.rst b/spiffworkflow-backend/docs/usage.rst deleted file mode 100644 index 308fe61e8..000000000 --- a/spiffworkflow-backend/docs/usage.rst +++ /dev/null @@ -1,6 +0,0 @@ -Usage -===== - -.. click:: spiffworkflow_backend.__main__:main - :prog: spiffworkflow-backend - :nested: full diff --git a/spiffworkflow-backend/noxfile.py b/spiffworkflow-backend/noxfile.py index 3d96a0e30..95fb2e3c6 100644 --- a/spiffworkflow-backend/noxfile.py +++ b/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)