From 8e3af21544ee5e0f0a3beac014477be3e420d6ff Mon Sep 17 00:00:00 2001 From: jasquat Date: Wed, 3 Jun 2026 12:10:02 -0400 Subject: [PATCH 1/2] rename doc to docs for consistency w/ burnettk --- .github/workflows/docs.yml | 8 ++++---- .readthedocs.yaml | 2 +- CONTRIB | 4 ++-- Makefile | 4 ++-- {doc => docs}/.gitignore | 0 {doc => docs}/Makefile | 0 {doc => docs}/_themes/spiffworks/globaltoc.html | 0 {doc => docs}/_themes/spiffworks/layout.html | 0 .../_themes/spiffworks/static/spiffworks.css | 0 {doc => docs}/_themes/spiffworks/theme.conf | 0 {doc => docs}/bin/serve_docs | 8 ++++---- {doc => docs}/bpmn/application.rst | 0 .../bpmn/camunda/figures/call_activity_multi.png | Bin .../bpmn/camunda/figures/documentation.png | Bin .../bpmn/camunda/figures/documentation_multi.png | Bin .../bpmn/camunda/figures/message_start_event.png | Bin .../figures/multiinstance_task_configuration.png | Bin .../bpmn/camunda/figures/throw_message_event.png | Bin {doc => docs}/bpmn/camunda/figures/user_task.png | Bin {doc => docs}/bpmn/camunda/index.rst | 0 {doc => docs}/bpmn/custom_task_spec.rst | 0 {doc => docs}/bpmn/data.rst | 0 {doc => docs}/bpmn/diffs.rst | 0 {doc => docs}/bpmn/errors.rst | 0 {doc => docs}/bpmn/imports.rst | 0 {doc => docs}/bpmn/index.rst | 0 {doc => docs}/bpmn/logging.rst | 0 {doc => docs}/bpmn/parsing.rst | 0 {doc => docs}/bpmn/script_engine.rst | 0 {doc => docs}/bpmn/serialization.rst | 0 {doc => docs}/bpmn/supported.rst | 0 {doc => docs}/bpmn/workflows.rst | 0 {doc => docs}/concepts.rst | 0 {doc => docs}/conf.py | 0 {doc => docs}/core/custom-tasks/index.rst | 0 {doc => docs}/core/custom-tasks/nuclear.json | 0 {doc => docs}/core/custom-tasks/serializer.py | 0 {doc => docs}/core/custom-tasks/start.py | 0 {doc => docs}/core/custom-tasks/strike.py | 0 {doc => docs}/core/index.rst | 0 {doc => docs}/core/patterns.rst | 0 {doc => docs}/core/tutorial/deserialize-wf.py | 0 {doc => docs}/core/tutorial/deserialize.py | 0 {doc => docs}/core/tutorial/index.rst | 0 {doc => docs}/core/tutorial/nuclear.json | 0 {doc => docs}/core/tutorial/nuclear.py | 0 {doc => docs}/core/tutorial/serialize-wf.py | 0 {doc => docs}/core/tutorial/serialize.py | 0 {doc => docs}/core/tutorial/start.py | 0 {doc => docs}/favicon.ico | Bin {doc => docs}/figures/action-management.png | Bin {doc => docs}/figures/classes.png | Bin {doc => docs}/figures/interaction.png | Bin {doc => docs}/figures/nuclear_strike.bpmn | 0 {doc => docs}/figures/state-diagram.png | Bin {doc => docs}/figures/state-diagram.svg | 0 {doc => docs}/images/logo.png | Bin {doc => docs}/index.rst | 0 {doc => docs}/make.bat | 0 {doc => docs}/modules.rst | 0 60 files changed, 13 insertions(+), 13 deletions(-) rename {doc => docs}/.gitignore (100%) rename {doc => docs}/Makefile (100%) rename {doc => docs}/_themes/spiffworks/globaltoc.html (100%) rename {doc => docs}/_themes/spiffworks/layout.html (100%) rename {doc => docs}/_themes/spiffworks/static/spiffworks.css (100%) rename {doc => docs}/_themes/spiffworks/theme.conf (100%) rename {doc => docs}/bin/serve_docs (85%) rename {doc => docs}/bpmn/application.rst (100%) rename {doc => docs}/bpmn/camunda/figures/call_activity_multi.png (100%) rename {doc => docs}/bpmn/camunda/figures/documentation.png (100%) rename {doc => docs}/bpmn/camunda/figures/documentation_multi.png (100%) rename {doc => docs}/bpmn/camunda/figures/message_start_event.png (100%) rename {doc => docs}/bpmn/camunda/figures/multiinstance_task_configuration.png (100%) rename {doc => docs}/bpmn/camunda/figures/throw_message_event.png (100%) rename {doc => docs}/bpmn/camunda/figures/user_task.png (100%) rename {doc => docs}/bpmn/camunda/index.rst (100%) rename {doc => docs}/bpmn/custom_task_spec.rst (100%) rename {doc => docs}/bpmn/data.rst (100%) rename {doc => docs}/bpmn/diffs.rst (100%) rename {doc => docs}/bpmn/errors.rst (100%) rename {doc => docs}/bpmn/imports.rst (100%) rename {doc => docs}/bpmn/index.rst (100%) rename {doc => docs}/bpmn/logging.rst (100%) rename {doc => docs}/bpmn/parsing.rst (100%) rename {doc => docs}/bpmn/script_engine.rst (100%) rename {doc => docs}/bpmn/serialization.rst (100%) rename {doc => docs}/bpmn/supported.rst (100%) rename {doc => docs}/bpmn/workflows.rst (100%) rename {doc => docs}/concepts.rst (100%) rename {doc => docs}/conf.py (100%) rename {doc => docs}/core/custom-tasks/index.rst (100%) rename {doc => docs}/core/custom-tasks/nuclear.json (100%) rename {doc => docs}/core/custom-tasks/serializer.py (100%) rename {doc => docs}/core/custom-tasks/start.py (100%) rename {doc => docs}/core/custom-tasks/strike.py (100%) rename {doc => docs}/core/index.rst (100%) rename {doc => docs}/core/patterns.rst (100%) rename {doc => docs}/core/tutorial/deserialize-wf.py (100%) rename {doc => docs}/core/tutorial/deserialize.py (100%) rename {doc => docs}/core/tutorial/index.rst (100%) rename {doc => docs}/core/tutorial/nuclear.json (100%) rename {doc => docs}/core/tutorial/nuclear.py (100%) rename {doc => docs}/core/tutorial/serialize-wf.py (100%) rename {doc => docs}/core/tutorial/serialize.py (100%) rename {doc => docs}/core/tutorial/start.py (100%) rename {doc => docs}/favicon.ico (100%) rename {doc => docs}/figures/action-management.png (100%) rename {doc => docs}/figures/classes.png (100%) rename {doc => docs}/figures/interaction.png (100%) rename {doc => docs}/figures/nuclear_strike.bpmn (100%) rename {doc => docs}/figures/state-diagram.png (100%) rename {doc => docs}/figures/state-diagram.svg (100%) rename {doc => docs}/images/logo.png (100%) rename {doc => docs}/index.rst (100%) rename {doc => docs}/make.bat (100%) rename {doc => docs}/modules.rst (100%) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index abab5bd42..1a4d90ad0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,12 +5,12 @@ on: branches: - main paths: - - 'doc/**' + - 'docs/**' pull_request: branches: - main paths: - - 'doc/**' + - 'docs/**' # Security: restrict GITHUB_TOKEN to least privilege. # See: https://www.upwind.io/feed/hackerbot-claw-github-actions-pull-request-rce @@ -23,7 +23,7 @@ jobs: runs-on: ubuntu-latest defaults: run: - working-directory: doc + working-directory: docs steps: - name: Check out the repository uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v4 @@ -48,7 +48,7 @@ jobs: uses: actions/upload-artifact@v4 with: name: docs-html - path: doc/_build/html/ + path: docs/_build/html/ sync-to-website: name: sync-docs-to-website diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a16226958..7915ac9e8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,7 +6,7 @@ build: python: "3.12" sphinx: - configuration: doc/conf.py + configuration: docs/conf.py python: install: diff --git a/CONTRIB b/CONTRIB index db52f1497..503f8b83d 100644 --- a/CONTRIB +++ b/CONTRIB @@ -51,10 +51,10 @@ Licensing: ## Releases For you dev op folks who release builds to the larger community ... -Update the release tag: doc/conf.py +Update the release tag: docs/conf.py And also edit setup.py and assure that has the same release tag. New versions of SpiffWorkflow are automatically published to PyPi whenever a maintainer of our GitHub repository creates a new release on GitHub. This is managed through GitHub's actions. The configuration of which can be found in .github/workflows/.... -Just create a release in GitHub that matches the release number in doc/conf.py +Just create a release in GitHub that matches the release number in docs/conf.py diff --git a/Makefile b/Makefile index 4e8619dbe..684d9b7d5 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ clean: find . -name "*.pyc" -o -name "*.pyo" | xargs -rn1 rm -f find . -name "*.egg-info" | xargs -rn1 rm -r rm -Rf build - cd doc; make clean + cd docs; make clean .PHONY : dist-clean dist-clean: clean @@ -21,7 +21,7 @@ dist-clean: clean .PHONY : doc doc: - cd doc; make html + cd docs; make html .PHONY : tests tests: diff --git a/doc/.gitignore b/docs/.gitignore similarity index 100% rename from doc/.gitignore rename to docs/.gitignore diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/_themes/spiffworks/globaltoc.html b/docs/_themes/spiffworks/globaltoc.html similarity index 100% rename from doc/_themes/spiffworks/globaltoc.html rename to docs/_themes/spiffworks/globaltoc.html diff --git a/doc/_themes/spiffworks/layout.html b/docs/_themes/spiffworks/layout.html similarity index 100% rename from doc/_themes/spiffworks/layout.html rename to docs/_themes/spiffworks/layout.html diff --git a/doc/_themes/spiffworks/static/spiffworks.css b/docs/_themes/spiffworks/static/spiffworks.css similarity index 100% rename from doc/_themes/spiffworks/static/spiffworks.css rename to docs/_themes/spiffworks/static/spiffworks.css diff --git a/doc/_themes/spiffworks/theme.conf b/docs/_themes/spiffworks/theme.conf similarity index 100% rename from doc/_themes/spiffworks/theme.conf rename to docs/_themes/spiffworks/theme.conf diff --git a/doc/bin/serve_docs b/docs/bin/serve_docs similarity index 85% rename from doc/bin/serve_docs rename to docs/bin/serve_docs index 99d985cbc..8acb8ad57 100755 --- a/doc/bin/serve_docs +++ b/docs/bin/serve_docs @@ -8,15 +8,15 @@ PORT="${PORT:-8001}" case "${1:-}" in -h|--help|help) cat <&2 - echo "Usage: doc/bin/serve_docs" >&2 + echo "Usage: docs/bin/serve_docs" >&2 exit 1 ;; esac diff --git a/doc/bpmn/application.rst b/docs/bpmn/application.rst similarity index 100% rename from doc/bpmn/application.rst rename to docs/bpmn/application.rst diff --git a/doc/bpmn/camunda/figures/call_activity_multi.png b/docs/bpmn/camunda/figures/call_activity_multi.png similarity index 100% rename from doc/bpmn/camunda/figures/call_activity_multi.png rename to docs/bpmn/camunda/figures/call_activity_multi.png diff --git a/doc/bpmn/camunda/figures/documentation.png b/docs/bpmn/camunda/figures/documentation.png similarity index 100% rename from doc/bpmn/camunda/figures/documentation.png rename to docs/bpmn/camunda/figures/documentation.png diff --git a/doc/bpmn/camunda/figures/documentation_multi.png b/docs/bpmn/camunda/figures/documentation_multi.png similarity index 100% rename from doc/bpmn/camunda/figures/documentation_multi.png rename to docs/bpmn/camunda/figures/documentation_multi.png diff --git a/doc/bpmn/camunda/figures/message_start_event.png b/docs/bpmn/camunda/figures/message_start_event.png similarity index 100% rename from doc/bpmn/camunda/figures/message_start_event.png rename to docs/bpmn/camunda/figures/message_start_event.png diff --git a/doc/bpmn/camunda/figures/multiinstance_task_configuration.png b/docs/bpmn/camunda/figures/multiinstance_task_configuration.png similarity index 100% rename from doc/bpmn/camunda/figures/multiinstance_task_configuration.png rename to docs/bpmn/camunda/figures/multiinstance_task_configuration.png diff --git a/doc/bpmn/camunda/figures/throw_message_event.png b/docs/bpmn/camunda/figures/throw_message_event.png similarity index 100% rename from doc/bpmn/camunda/figures/throw_message_event.png rename to docs/bpmn/camunda/figures/throw_message_event.png diff --git a/doc/bpmn/camunda/figures/user_task.png b/docs/bpmn/camunda/figures/user_task.png similarity index 100% rename from doc/bpmn/camunda/figures/user_task.png rename to docs/bpmn/camunda/figures/user_task.png diff --git a/doc/bpmn/camunda/index.rst b/docs/bpmn/camunda/index.rst similarity index 100% rename from doc/bpmn/camunda/index.rst rename to docs/bpmn/camunda/index.rst diff --git a/doc/bpmn/custom_task_spec.rst b/docs/bpmn/custom_task_spec.rst similarity index 100% rename from doc/bpmn/custom_task_spec.rst rename to docs/bpmn/custom_task_spec.rst diff --git a/doc/bpmn/data.rst b/docs/bpmn/data.rst similarity index 100% rename from doc/bpmn/data.rst rename to docs/bpmn/data.rst diff --git a/doc/bpmn/diffs.rst b/docs/bpmn/diffs.rst similarity index 100% rename from doc/bpmn/diffs.rst rename to docs/bpmn/diffs.rst diff --git a/doc/bpmn/errors.rst b/docs/bpmn/errors.rst similarity index 100% rename from doc/bpmn/errors.rst rename to docs/bpmn/errors.rst diff --git a/doc/bpmn/imports.rst b/docs/bpmn/imports.rst similarity index 100% rename from doc/bpmn/imports.rst rename to docs/bpmn/imports.rst diff --git a/doc/bpmn/index.rst b/docs/bpmn/index.rst similarity index 100% rename from doc/bpmn/index.rst rename to docs/bpmn/index.rst diff --git a/doc/bpmn/logging.rst b/docs/bpmn/logging.rst similarity index 100% rename from doc/bpmn/logging.rst rename to docs/bpmn/logging.rst diff --git a/doc/bpmn/parsing.rst b/docs/bpmn/parsing.rst similarity index 100% rename from doc/bpmn/parsing.rst rename to docs/bpmn/parsing.rst diff --git a/doc/bpmn/script_engine.rst b/docs/bpmn/script_engine.rst similarity index 100% rename from doc/bpmn/script_engine.rst rename to docs/bpmn/script_engine.rst diff --git a/doc/bpmn/serialization.rst b/docs/bpmn/serialization.rst similarity index 100% rename from doc/bpmn/serialization.rst rename to docs/bpmn/serialization.rst diff --git a/doc/bpmn/supported.rst b/docs/bpmn/supported.rst similarity index 100% rename from doc/bpmn/supported.rst rename to docs/bpmn/supported.rst diff --git a/doc/bpmn/workflows.rst b/docs/bpmn/workflows.rst similarity index 100% rename from doc/bpmn/workflows.rst rename to docs/bpmn/workflows.rst diff --git a/doc/concepts.rst b/docs/concepts.rst similarity index 100% rename from doc/concepts.rst rename to docs/concepts.rst diff --git a/doc/conf.py b/docs/conf.py similarity index 100% rename from doc/conf.py rename to docs/conf.py diff --git a/doc/core/custom-tasks/index.rst b/docs/core/custom-tasks/index.rst similarity index 100% rename from doc/core/custom-tasks/index.rst rename to docs/core/custom-tasks/index.rst diff --git a/doc/core/custom-tasks/nuclear.json b/docs/core/custom-tasks/nuclear.json similarity index 100% rename from doc/core/custom-tasks/nuclear.json rename to docs/core/custom-tasks/nuclear.json diff --git a/doc/core/custom-tasks/serializer.py b/docs/core/custom-tasks/serializer.py similarity index 100% rename from doc/core/custom-tasks/serializer.py rename to docs/core/custom-tasks/serializer.py diff --git a/doc/core/custom-tasks/start.py b/docs/core/custom-tasks/start.py similarity index 100% rename from doc/core/custom-tasks/start.py rename to docs/core/custom-tasks/start.py diff --git a/doc/core/custom-tasks/strike.py b/docs/core/custom-tasks/strike.py similarity index 100% rename from doc/core/custom-tasks/strike.py rename to docs/core/custom-tasks/strike.py diff --git a/doc/core/index.rst b/docs/core/index.rst similarity index 100% rename from doc/core/index.rst rename to docs/core/index.rst diff --git a/doc/core/patterns.rst b/docs/core/patterns.rst similarity index 100% rename from doc/core/patterns.rst rename to docs/core/patterns.rst diff --git a/doc/core/tutorial/deserialize-wf.py b/docs/core/tutorial/deserialize-wf.py similarity index 100% rename from doc/core/tutorial/deserialize-wf.py rename to docs/core/tutorial/deserialize-wf.py diff --git a/doc/core/tutorial/deserialize.py b/docs/core/tutorial/deserialize.py similarity index 100% rename from doc/core/tutorial/deserialize.py rename to docs/core/tutorial/deserialize.py diff --git a/doc/core/tutorial/index.rst b/docs/core/tutorial/index.rst similarity index 100% rename from doc/core/tutorial/index.rst rename to docs/core/tutorial/index.rst diff --git a/doc/core/tutorial/nuclear.json b/docs/core/tutorial/nuclear.json similarity index 100% rename from doc/core/tutorial/nuclear.json rename to docs/core/tutorial/nuclear.json diff --git a/doc/core/tutorial/nuclear.py b/docs/core/tutorial/nuclear.py similarity index 100% rename from doc/core/tutorial/nuclear.py rename to docs/core/tutorial/nuclear.py diff --git a/doc/core/tutorial/serialize-wf.py b/docs/core/tutorial/serialize-wf.py similarity index 100% rename from doc/core/tutorial/serialize-wf.py rename to docs/core/tutorial/serialize-wf.py diff --git a/doc/core/tutorial/serialize.py b/docs/core/tutorial/serialize.py similarity index 100% rename from doc/core/tutorial/serialize.py rename to docs/core/tutorial/serialize.py diff --git a/doc/core/tutorial/start.py b/docs/core/tutorial/start.py similarity index 100% rename from doc/core/tutorial/start.py rename to docs/core/tutorial/start.py diff --git a/doc/favicon.ico b/docs/favicon.ico similarity index 100% rename from doc/favicon.ico rename to docs/favicon.ico diff --git a/doc/figures/action-management.png b/docs/figures/action-management.png similarity index 100% rename from doc/figures/action-management.png rename to docs/figures/action-management.png diff --git a/doc/figures/classes.png b/docs/figures/classes.png similarity index 100% rename from doc/figures/classes.png rename to docs/figures/classes.png diff --git a/doc/figures/interaction.png b/docs/figures/interaction.png similarity index 100% rename from doc/figures/interaction.png rename to docs/figures/interaction.png diff --git a/doc/figures/nuclear_strike.bpmn b/docs/figures/nuclear_strike.bpmn similarity index 100% rename from doc/figures/nuclear_strike.bpmn rename to docs/figures/nuclear_strike.bpmn diff --git a/doc/figures/state-diagram.png b/docs/figures/state-diagram.png similarity index 100% rename from doc/figures/state-diagram.png rename to docs/figures/state-diagram.png diff --git a/doc/figures/state-diagram.svg b/docs/figures/state-diagram.svg similarity index 100% rename from doc/figures/state-diagram.svg rename to docs/figures/state-diagram.svg diff --git a/doc/images/logo.png b/docs/images/logo.png similarity index 100% rename from doc/images/logo.png rename to docs/images/logo.png diff --git a/doc/index.rst b/docs/index.rst similarity index 100% rename from doc/index.rst rename to docs/index.rst diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/modules.rst b/docs/modules.rst similarity index 100% rename from doc/modules.rst rename to docs/modules.rst From edd4c572679a4fe2ed5885ee00f060184db9e4c2 Mon Sep 17 00:00:00 2001 From: jasquat Date: Wed, 3 Jun 2026 12:26:49 -0400 Subject: [PATCH 2/2] fix test w/ burnettk --- tests/SpiffWorkflow/core/docTest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/SpiffWorkflow/core/docTest.py b/tests/SpiffWorkflow/core/docTest.py index 766580466..977d9e1a5 100644 --- a/tests/SpiffWorkflow/core/docTest.py +++ b/tests/SpiffWorkflow/core/docTest.py @@ -5,7 +5,7 @@ dirname = os.path.abspath(os.path.dirname(__file__)) sys.path.insert(0, os.path.join(dirname, '..', '..', '..')) -doc_dir = os.path.join(dirname, '..', '..', '..', 'doc') +doc_dir = os.path.join(dirname, '..', '..', '..', 'docs') class TutorialTest: