Updated help.

development
Shawn Davis 2 years ago
parent aad47de6a1
commit c8c998b6ed
  1. 2
      .gitignore
  2. 16
      Makefile
  3. 0
      help/en/docs/cli.md
  4. 0
      help/en/docs/getting-started.md
  5. 0
      help/en/docs/how-to/create-executable-script.md
  6. 0
      help/en/docs/how-to/define-custom-command.md
  7. 0
      help/en/docs/how-to/images/slack-1.jpg
  8. 0
      help/en/docs/how-to/images/slack-2.jpg
  9. 0
      help/en/docs/how-to/images/slack-3.jpg
  10. 0
      help/en/docs/how-to/images/twist-1.png
  11. 0
      help/en/docs/how-to/images/twist-2.png
  12. 0
      help/en/docs/how-to/post-message-slack.md
  13. 0
      help/en/docs/how-to/post-message-twist.md
  14. 0
      help/en/docs/how-to/use-with-commonkit.md
  15. 0
      help/en/docs/index.md
  16. 0
      help/en/docs/topics/itemized-commands.md
  17. 0
      help/en/docs/topics/steps-file.md
  18. 0
      help/en/docs/topics/templates.md
  19. 0
      help/en/docs/topics/variables.md
  20. 0
      help/en/docs/usage/centos.md
  21. 0
      help/en/docs/usage/django.md
  22. 0
      help/en/docs/usage/messages.md
  23. 0
      help/en/docs/usage/mysql.md
  24. 0
      help/en/docs/usage/pgsql.md
  25. 0
      help/en/docs/usage/php.md
  26. 0
      help/en/docs/usage/posix.md
  27. 0
      help/en/docs/usage/python.md
  28. 0
      help/en/docs/usage/ubuntu.md
  29. 0
      help/en/mkdocs.yml
  30. 2
      setup.py

2
.gitignore vendored

@ -12,7 +12,7 @@ _scraps
build build
dist dist
docs/build docs/build
help/site help/*/site
htmlcov htmlcov
tmp.* tmp.*
tmp tmp

@ -13,6 +13,8 @@ COVERAGE_PATH := docs/build/html/coverage
#RELEASE := $(strip $(file < RELEASE.txt)) #RELEASE := $(strip $(file < RELEASE.txt))
RELEASE := $(strip `cat RELEASE.txt`) RELEASE := $(strip `cat RELEASE.txt`)
VERSION := $(strip `cat VERSION.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. # Attempt to load a local makefile which may override any of the values above.
-include local.makefile -include local.makefile
@ -72,6 +74,20 @@ publish:
secure: secure:
bandit -r $(PACKAGE_NAME); 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 - Run unit tests and generate coverage report.
tests: tests:
coverage run --source=. -m pytest; coverage run --source=. -m pytest;

Before

Width:  |  Height:  |  Size: 301 KiB

After

Width:  |  Height:  |  Size: 301 KiB

Before

Width:  |  Height:  |  Size: 393 KiB

After

Width:  |  Height:  |  Size: 393 KiB

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

Before

Width:  |  Height:  |  Size: 111 KiB

After

Width:  |  Height:  |  Size: 111 KiB

Before

Width:  |  Height:  |  Size: 181 KiB

After

Width:  |  Height:  |  Size: 181 KiB

@ -22,7 +22,7 @@ setup(
url='https://develmaycare.com/products/python/scripttease/', url='https://develmaycare.com/products/python/scripttease/',
download_url='https://gittraction.com/diff6/python-scripttease', download_url='https://gittraction.com/diff6/python-scripttease',
project_urls={ 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", 'Source': "https://gittraction.com/diff6/python-scripttease",
'Tracker': "https://gittraction.com/diff6/python-scripttease/issues" 'Tracker': "https://gittraction.com/diff6/python-scripttease/issues"
}, },

Loading…
Cancel
Save