From c8c998b6ed7e5c4d0d2e7bf6716209a8a8928b77 Mon Sep 17 00:00:00 2001 From: Shawn Davis Date: Sun, 16 Apr 2023 22:15:32 -0500 Subject: [PATCH] Updated help. --- .gitignore | 2 +- Makefile | 16 ++++++++++++++++ help/{ => en}/docs/cli.md | 0 help/{ => en}/docs/getting-started.md | 0 .../docs/how-to/create-executable-script.md | 0 .../docs/how-to/define-custom-command.md | 0 help/{ => en}/docs/how-to/images/slack-1.jpg | Bin help/{ => en}/docs/how-to/images/slack-2.jpg | Bin help/{ => en}/docs/how-to/images/slack-3.jpg | Bin help/{ => en}/docs/how-to/images/twist-1.png | Bin help/{ => en}/docs/how-to/images/twist-2.png | Bin help/{ => en}/docs/how-to/post-message-slack.md | 0 help/{ => en}/docs/how-to/post-message-twist.md | 0 help/{ => en}/docs/how-to/use-with-commonkit.md | 0 help/{ => en}/docs/index.md | 0 help/{ => en}/docs/topics/itemized-commands.md | 0 help/{ => en}/docs/topics/steps-file.md | 0 help/{ => en}/docs/topics/templates.md | 0 help/{ => en}/docs/topics/variables.md | 0 help/{ => en}/docs/usage/centos.md | 0 help/{ => en}/docs/usage/django.md | 0 help/{ => en}/docs/usage/messages.md | 0 help/{ => en}/docs/usage/mysql.md | 0 help/{ => en}/docs/usage/pgsql.md | 0 help/{ => en}/docs/usage/php.md | 0 help/{ => en}/docs/usage/posix.md | 0 help/{ => en}/docs/usage/python.md | 0 help/{ => en}/docs/usage/ubuntu.md | 0 help/{ => en}/mkdocs.yml | 0 setup.py | 2 +- 30 files changed, 18 insertions(+), 2 deletions(-) rename help/{ => en}/docs/cli.md (100%) rename help/{ => en}/docs/getting-started.md (100%) rename help/{ => en}/docs/how-to/create-executable-script.md (100%) rename help/{ => en}/docs/how-to/define-custom-command.md (100%) rename help/{ => en}/docs/how-to/images/slack-1.jpg (100%) rename help/{ => en}/docs/how-to/images/slack-2.jpg (100%) rename help/{ => en}/docs/how-to/images/slack-3.jpg (100%) rename help/{ => en}/docs/how-to/images/twist-1.png (100%) rename help/{ => en}/docs/how-to/images/twist-2.png (100%) rename help/{ => en}/docs/how-to/post-message-slack.md (100%) rename help/{ => en}/docs/how-to/post-message-twist.md (100%) rename help/{ => en}/docs/how-to/use-with-commonkit.md (100%) rename help/{ => en}/docs/index.md (100%) rename help/{ => en}/docs/topics/itemized-commands.md (100%) rename help/{ => en}/docs/topics/steps-file.md (100%) rename help/{ => en}/docs/topics/templates.md (100%) rename help/{ => en}/docs/topics/variables.md (100%) rename help/{ => en}/docs/usage/centos.md (100%) rename help/{ => en}/docs/usage/django.md (100%) rename help/{ => en}/docs/usage/messages.md (100%) rename help/{ => en}/docs/usage/mysql.md (100%) rename help/{ => en}/docs/usage/pgsql.md (100%) rename help/{ => en}/docs/usage/php.md (100%) rename help/{ => en}/docs/usage/posix.md (100%) rename help/{ => en}/docs/usage/python.md (100%) rename help/{ => en}/docs/usage/ubuntu.md (100%) rename help/{ => en}/mkdocs.yml (100%) diff --git a/.gitignore b/.gitignore index 7d7c3c2..e692181 100644 --- a/.gitignore +++ b/.gitignore @@ -12,7 +12,7 @@ _scraps build dist docs/build -help/site +help/*/site htmlcov tmp.* tmp diff --git a/Makefile b/Makefile index 9034231..0681ec0 100644 --- a/Makefile +++ b/Makefile @@ -13,6 +13,8 @@ COVERAGE_PATH := docs/build/html/coverage #RELEASE := $(strip $(file < RELEASE.txt)) RELEASE := $(strip `cat RELEASE.txt`) VERSION := $(strip `cat VERSION.txt`) +DOCS_PATH := $(PROJECT_HOME)/docs_diff6_com +DOCS_WWW := $(DOCS_PATH)/www # Attempt to load a local makefile which may override any of the values above. -include local.makefile @@ -72,6 +74,20 @@ publish: secure: bandit -r $(PACKAGE_NAME); + +#> support - Build support (help) and reference documentation. +support: + cd docs && make dirhtml; + cd help/en/ && mkdocs build; + test -d $(DOCS_WWW)/en/$(PROJECT_NAME)/$(RELEASE) || mkdir -p $(DOCS_WWW)/en/$(PROJECT_NAME)/$(RELEASE); + test -d $(DOCS_WWW)/en/$(PROJECT_NAME)/$(RELEASE)/reference || mkdir -p $(DOCS_WWW)/en/$(PROJECT_NAME)/$(RELEASE)/reference; + cp -R docs/build/dirhtml/* $(DOCS_WWW)/en/$(PROJECT_NAME)/$(RELEASE)/reference/; + cp -R help/en/site/* $(DOCS_WWW)/en/$(PROJECT_NAME)/$(RELEASE)/; + cp meta.ini $(DOCS_PATH)/config/$(PROJECT_NAME).ini; + cd $(DOCS_WWW)/en/$(PROJECT_NAME) && ln -fs $(RELEASE) latest; + cd $(DOCS_WWW)/en/$(PROJECT_NAME) && ln -fs $(RELEASE) stable; # if product is stable + cd $(DOCS_PATH) && make build; + #> tests - Run unit tests and generate coverage report. tests: coverage run --source=. -m pytest; diff --git a/help/docs/cli.md b/help/en/docs/cli.md similarity index 100% rename from help/docs/cli.md rename to help/en/docs/cli.md diff --git a/help/docs/getting-started.md b/help/en/docs/getting-started.md similarity index 100% rename from help/docs/getting-started.md rename to help/en/docs/getting-started.md diff --git a/help/docs/how-to/create-executable-script.md b/help/en/docs/how-to/create-executable-script.md similarity index 100% rename from help/docs/how-to/create-executable-script.md rename to help/en/docs/how-to/create-executable-script.md diff --git a/help/docs/how-to/define-custom-command.md b/help/en/docs/how-to/define-custom-command.md similarity index 100% rename from help/docs/how-to/define-custom-command.md rename to help/en/docs/how-to/define-custom-command.md diff --git a/help/docs/how-to/images/slack-1.jpg b/help/en/docs/how-to/images/slack-1.jpg similarity index 100% rename from help/docs/how-to/images/slack-1.jpg rename to help/en/docs/how-to/images/slack-1.jpg diff --git a/help/docs/how-to/images/slack-2.jpg b/help/en/docs/how-to/images/slack-2.jpg similarity index 100% rename from help/docs/how-to/images/slack-2.jpg rename to help/en/docs/how-to/images/slack-2.jpg diff --git a/help/docs/how-to/images/slack-3.jpg b/help/en/docs/how-to/images/slack-3.jpg similarity index 100% rename from help/docs/how-to/images/slack-3.jpg rename to help/en/docs/how-to/images/slack-3.jpg diff --git a/help/docs/how-to/images/twist-1.png b/help/en/docs/how-to/images/twist-1.png similarity index 100% rename from help/docs/how-to/images/twist-1.png rename to help/en/docs/how-to/images/twist-1.png diff --git a/help/docs/how-to/images/twist-2.png b/help/en/docs/how-to/images/twist-2.png similarity index 100% rename from help/docs/how-to/images/twist-2.png rename to help/en/docs/how-to/images/twist-2.png diff --git a/help/docs/how-to/post-message-slack.md b/help/en/docs/how-to/post-message-slack.md similarity index 100% rename from help/docs/how-to/post-message-slack.md rename to help/en/docs/how-to/post-message-slack.md diff --git a/help/docs/how-to/post-message-twist.md b/help/en/docs/how-to/post-message-twist.md similarity index 100% rename from help/docs/how-to/post-message-twist.md rename to help/en/docs/how-to/post-message-twist.md diff --git a/help/docs/how-to/use-with-commonkit.md b/help/en/docs/how-to/use-with-commonkit.md similarity index 100% rename from help/docs/how-to/use-with-commonkit.md rename to help/en/docs/how-to/use-with-commonkit.md diff --git a/help/docs/index.md b/help/en/docs/index.md similarity index 100% rename from help/docs/index.md rename to help/en/docs/index.md diff --git a/help/docs/topics/itemized-commands.md b/help/en/docs/topics/itemized-commands.md similarity index 100% rename from help/docs/topics/itemized-commands.md rename to help/en/docs/topics/itemized-commands.md diff --git a/help/docs/topics/steps-file.md b/help/en/docs/topics/steps-file.md similarity index 100% rename from help/docs/topics/steps-file.md rename to help/en/docs/topics/steps-file.md diff --git a/help/docs/topics/templates.md b/help/en/docs/topics/templates.md similarity index 100% rename from help/docs/topics/templates.md rename to help/en/docs/topics/templates.md diff --git a/help/docs/topics/variables.md b/help/en/docs/topics/variables.md similarity index 100% rename from help/docs/topics/variables.md rename to help/en/docs/topics/variables.md diff --git a/help/docs/usage/centos.md b/help/en/docs/usage/centos.md similarity index 100% rename from help/docs/usage/centos.md rename to help/en/docs/usage/centos.md diff --git a/help/docs/usage/django.md b/help/en/docs/usage/django.md similarity index 100% rename from help/docs/usage/django.md rename to help/en/docs/usage/django.md diff --git a/help/docs/usage/messages.md b/help/en/docs/usage/messages.md similarity index 100% rename from help/docs/usage/messages.md rename to help/en/docs/usage/messages.md diff --git a/help/docs/usage/mysql.md b/help/en/docs/usage/mysql.md similarity index 100% rename from help/docs/usage/mysql.md rename to help/en/docs/usage/mysql.md diff --git a/help/docs/usage/pgsql.md b/help/en/docs/usage/pgsql.md similarity index 100% rename from help/docs/usage/pgsql.md rename to help/en/docs/usage/pgsql.md diff --git a/help/docs/usage/php.md b/help/en/docs/usage/php.md similarity index 100% rename from help/docs/usage/php.md rename to help/en/docs/usage/php.md diff --git a/help/docs/usage/posix.md b/help/en/docs/usage/posix.md similarity index 100% rename from help/docs/usage/posix.md rename to help/en/docs/usage/posix.md diff --git a/help/docs/usage/python.md b/help/en/docs/usage/python.md similarity index 100% rename from help/docs/usage/python.md rename to help/en/docs/usage/python.md diff --git a/help/docs/usage/ubuntu.md b/help/en/docs/usage/ubuntu.md similarity index 100% rename from help/docs/usage/ubuntu.md rename to help/en/docs/usage/ubuntu.md diff --git a/help/mkdocs.yml b/help/en/mkdocs.yml similarity index 100% rename from help/mkdocs.yml rename to help/en/mkdocs.yml diff --git a/setup.py b/setup.py index c48a6f4..5a53e32 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ setup( url='https://develmaycare.com/products/python/scripttease/', download_url='https://gittraction.com/diff6/python-scripttease', project_urls={ - 'Documentation': "https://docs.develmaycare.com/en/python-scripttease/latest/", + 'Documentation': "https://docs.diff6.com/en/python-scripttease/latest/", 'Source': "https://gittraction.com/diff6/python-scripttease", 'Tracker': "https://gittraction.com/diff6/python-scripttease/issues" },