diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000000000000000000000000000000000..9ff7684d0d7445be442072735d962495c1a09746 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,23 @@ +# EditorConfig is awesome: http://EditorConfig.org +# +# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.editorconfig + +# top-most EditorConfig file +root = false + +[{*.rst, *.rst.txt}] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 3 + +# MD-Files +[*.md] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 4 diff --git a/.gitignore b/.gitignore index 0c3dfc755166daef2dd1a7ee2007a14fe7fcd1dc..01b8b622c15105216a5ca6af707303ce7a24cc47 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,17 @@ +# ignore generated documentation +*GENERATED* + +# ignore typical clutter of IDEs and editors (this could be added in .git/info/exclude, +# but we add it here for convenience) +*~ +*.bak +*.idea +*.project +*.swp +.project +.webprj +nbprojec + # Created by .ignore support plugin (hsz.mobi) .python_virtualenv/ .virtual_env @@ -16,6 +30,7 @@ test.json test.php *.autosave +/Documentation-GENERATED-temp /bower_components /composer.phar /css diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5a3a397403835198b637b89f0a1aff28abf5398a..fb58bba0594b5bbe95451a7fdc80c95dc890d4b9 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,7 +1,19 @@ before_script: - VERSION=`cat ./version` +stages: + - before + - build + +documentation: + stage: before + script: + - docker pull t3docs/render-documentation + - source <(docker run --rm t3docs/render-documentation show-shell-commands) + - dockrun_t3rd makehtml + snapshot: + stage: build except: - tags script: @@ -10,6 +22,7 @@ snapshot: - scp qfq_$VERSION_*.zip w16:qfq/snapshots/ release: + stage: build only: - tags script: diff --git a/extension/Documentation/Includes.txt b/Documentation/Includes.txt similarity index 89% rename from extension/Documentation/Includes.txt rename to Documentation/Includes.txt index 8ef89a78a7c5d543615d41c7e9a50404b0c88ee5..a111144fac0b258fe3f5759d6df38657d5a31e30 100644 --- a/extension/Documentation/Includes.txt +++ b/Documentation/Includes.txt @@ -1,4 +1,4 @@ -.. ================================================== +.. ================================================== .. FOR YOUR INFORMATION .. -------------------------------------------------- .. -*- coding: utf-8 -*- with BOM. diff --git a/extension/Documentation/Index.rst b/Documentation/Index.rst similarity index 96% rename from extension/Documentation/Index.rst rename to Documentation/Index.rst index 7837ba16840eae1afc2ebad161717c69e8c142ac..346ae772f16acb5a7e40e8ddb6f1f269f163ce77 100644 --- a/extension/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,4 +1,4 @@ -.. ================================================== +.. ================================================== .. FOR YOUR INFORMATION TEST .. -------------------------------------------------- .. -*- coding: utf-8 -*- with BOM. diff --git a/extension/Documentation/License.rst b/Documentation/License.rst similarity index 100% rename from extension/Documentation/License.rst rename to Documentation/License.rst diff --git a/Documentation/Links.rst b/Documentation/Links.rst new file mode 100644 index 0000000000000000000000000000000000000000..d51d0bfa3fc0869195d8282295afe615bd684dc4 --- /dev/null +++ b/Documentation/Links.rst @@ -0,0 +1,27 @@ +.. include:: Includes.txt + + +.. _links: + +Links +----- + +The links to issue and the GitHub repository are maintained in the Settings.cfg. + +You may want to remove this file if all important links are already handled in +Settings.cfg. + +:Packagist: + https://packagist.org/packages// + +:TER: + https://typo3.org/extensions/repository/view/ + +:Issues: + https://github.com///issues + +:GitHub Repository: + https://github.com// + +:Contact: + `@ `__ diff --git a/extension/Documentation/Manual.rst b/Documentation/Manual.rst similarity index 99% rename from extension/Documentation/Manual.rst rename to Documentation/Manual.rst index 2a34541abe657d2c92f8c83dbdf95582a30899eb..7fdae5c9cfa11630610f34660e8f2c006b425301 100644 --- a/extension/Documentation/Manual.rst +++ b/Documentation/Manual.rst @@ -8,14 +8,16 @@ .. ,, .. .. -------------------------------------------------- -.. Best Practice T3 reST https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/ +.. Best Practice T3 reST: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CheatSheet.html +.. Reference: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/Index.html .. Italic *italic*are part of key or value .. Bold **bold** .. Code ``text`` .. External Links: `Bootstrap `_ -.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images ... +.. Add Images: .. image:: ../images/a4.jpg .. -.. Admonitions (https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/#admonitions) +.. +.. Admonitions .. .. note:: .. important:: .. tip:: .. warning:: .. Color: (grey) (orange) (green) (red) .. diff --git a/extension/Documentation/OnlineRecuitingTool.rst b/Documentation/OnlineRecuitingTool.rst similarity index 100% rename from extension/Documentation/OnlineRecuitingTool.rst rename to Documentation/OnlineRecuitingTool.rst diff --git a/extension/Documentation/Release.rst b/Documentation/Release.rst similarity index 100% rename from extension/Documentation/Release.rst rename to Documentation/Release.rst diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg new file mode 100644 index 0000000000000000000000000000000000000000..ae586e0a90e68481b672e7b9d95e9e2a86c34e2f --- /dev/null +++ b/Documentation/Settings.cfg @@ -0,0 +1,82 @@ +# coding: utf-8 + +# ##### +# +# Settings.cfg - A TYPO3 Documentation Project's Configuration File +# Information about Settings.cfg: +# https://docs.typo3.org/typo3cms/HowToDocument/GeneralConventions/DirectoryFilenames.html#settings-cfg +# +# About Syntax: +# See https://docs.python.org/2/library/configparser.html +# +# Attention: +# Only " ;" can start an inline comment. +# This is: blank PLUS semicolon! +# +# ##### + +[general] + +; endless list of all of the general simple settings +; you can use in 'conf.py' + +project = QFQ - Quick Form Query +version = 19.5 +release = 19.5.1 +t3author = Carsten Rose +copyright = since 2017 by the author + +description = Documentation for the Typo3 Extension 'QFQ' + +[html_theme_options] + +; for theme t3SphinxThemeRtd + +# NOTE: Fill in YOUR values in the following! + +;github_branch = latest +;github_commit_hash = +;github_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/ +;github_revision_msg = +;github_sphinx_locale = + +# project_contact = documentation@typo3.org +project_contact = carsten.rose@math.uzh.ch +# project_discussions= http://... +project_discussions = https://hello.math.uzh.ch/channel/qfq +# project_home = +project_home = https://git.math.uzh.ch/typo3/qfq +# project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/issues +project_issues = https://project.math.uzh.ch/projects/qfq/issues +# project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual +project_repository = https://git.math.uzh.ch/typo3/qfq +use_opensearch = + + + +[intersphinx_mapping] + +; Comment out what you don't use. +; Uncomment only what you actually use in crossreferencing! + +# t3api = https://typo3.org/api/typo3cms/ +# t3cgl = https://docs.typo3.org/typo3cms/CodingGuidelinesReference/ +# t3coreapi = https://docs.typo3.org/typo3cms/CoreApiReference/ +# t3editors = https://docs.typo3.org/typo3cms/EditorsTutorial/ +# t3extbasebook = https://docs.typo3.org/typo3cms/ExtbaseFluidBook/ +# t3fal = https://docs.typo3.org/typo3cms/FileAbstractionLayerReference/ +# t3inside = https://docs.typo3.org/typo3cms/InsideTypo3Reference/ +# t3install = https://docs.typo3.org/typo3cms/InstallationGuide/ +# t3l10n = https://docs.typo3.org/typo3cms/FrontendLocalizationGuide/ +# t3security = https://docs.typo3.org/typo3cms/SecurityGuide/ +# t3services = https://docs.typo3.org/typo3cms/Typo3ServicesReference/ +# t3skinning = https://docs.typo3.org/typo3cms/SkinningReference/ +# t3start = https://docs.typo3.org/typo3cms/GettingStartedTutorial/ +# t3tca = https://docs.typo3.org/typo3cms/TCAReference/ +# t3templating = https://docs.typo3.org/typo3cms/TemplatingTutorial/ +# t3ts45 = https://docs.typo3.org/typo3cms/TyposcriptIn45MinutesTutorial/ +# t3tsconfig = https://docs.typo3.org/typo3cms/TSconfigReference/ +# t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference/ +# t3tssyntax = https://docs.typo3.org/typo3cms/TyposcriptSyntaxReference/ + + diff --git a/Makefile b/Makefile index e367fd58cff0bda1cefbc178e1803ca9b5c31348..5e2f84d4cbe728d2c17cdb23fb3b7c3a48e3c1b5 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,5 @@ +SHELL := /bin/bash + PKG_VERSION = $(shell awk '/version/ { print $$3 }' extension/ext_emconf.php | sed "s/'//g") NIGHTLY_DATE = $(shell date '+%Y%m%d') @@ -6,14 +8,14 @@ RELEASE_DATE = $(shell date '+%Y%m%d%H%M') GIT_REVISION_SHORT = $(shell git rev-parse --short HEAD || true) GIT_REVISION_LONG = $(shell git rev-parse HEAD || true) -EXTENSION_CONTENT = Classes Configuration Documentation Source Resources ext_emconf.php ext_localconf.php ext_tables.php ext_icon.png ext_conf_template.txt config.qfq.example.php RELEASE.txt vendor +EXTENSION_CONTENT = Classes Configuration Source Resources ext_emconf.php ext_localconf.php ext_tables.php ext_icon.png ext_conf_template.txt config.qfq.example.php RELEASE.txt vendor DISTDIR=dist # Use by jenkins to separate temp directories used by pip in order to allow concurrent builds PIP_TMP ?= /tmp -all: archive t3sphinx +all: archive maintainer-clean: rm -f .doc_plantuml .npmpackages .phpdocinstall .plantuml_install .support .support_plantuml @@ -28,14 +30,6 @@ qfq.zip: clean: cd doc/diagram ; $(MAKE) $@ -update-qfq-doc: - rsync -av --delete --exclude=_make --exclude=_static extension/Documentation/ ../qfq-doc/Documentation/; \ - cd ../qfq-doc/; \ - git commit -a; \ - git push - wget -O /dev/null https://docs.typo3.org/~mbless/github.com/T3DocumentationStarter/Public-Info-053.git.make/request_rebuild.php - - git-revision: make-dist-dir echo $(GIT_REVISION_LONG) > $(DISTDIR)/revision.git @@ -43,17 +37,10 @@ make-dist-dir: rm -rf $(DISTDIR)/ mkdir $(DISTDIR) -dist-move-doc: - cd $(DISTDIR) ; \ - mkdir Documentation.tmp ;\ - mv Documentation/_make/build/html Documentation.tmp ;\ - rm -rf Documentation ; \ - mv Documentation.tmp Documentation - dist-copy-extension: cd extension ; cp -R $(EXTENSION_CONTENT) ../$(DISTDIR)/ -build-dist: t3sphinx make-dist-dir dist-copy-extension dist-move-doc git-revision +build-dist: make-dist-dir dist-copy-extension git-revision echo "Distribution made in $(DIST)" nightly: basic build-dist @@ -66,9 +53,6 @@ release: basic build-dist if [ -z "$(VERSION)" ] ; then echo "Set VERSION make variable to the release version (fmt: maj.min.micro)" ; exit 1 ; fi cd $(DISTDIR) ; zip -r "../qfq_$(VERSION)_$(RELEASE_DATE).zip" $(EXTENSION_CONTENT) revision.git -x config.ini -t3sphinx: .virtual_env - . .python_virtualenv/bin/activate ; cd extension/Documentation/_make; make html - plantuml: cd doc/diagram ; $(MAKE) @@ -111,11 +95,11 @@ basic: .npmpackages .virtual_env pip-temp-directory: test -d "$(PIP_TMP)" || mkdir -p "$(PIP_TMP)" -.PHONY: nightly maintainer-clean snapshot release git-revision t3sphinx build-dist make-dist-dir dist-move-doc dist-copy-extension pip-temp-directory plantuml sonar +.PHONY: nightly maintainer-clean snapshot release git-revision build-dist make-dist-dir dist-copy-extension pip-temp-directory plantuml sonar copyReleaseNotes: - cp extension/Documentation/Release.rst extension/RELEASE.txt - cp extension/Documentation/Release.rst CHANGELOG.md + cp Documentation/Release.rst extension/RELEASE.txt + cp Documentation/Release.rst CHANGELOG.md phpunit: # update composer with dev to install phpunit package @@ -135,4 +119,9 @@ phpunit: phpunit_snapshot: snapshot phpunit phpunit_release: release phpunit - + +doc-local: + source docker/_helper_functions.sh; makePathExecutable "${PWD}/../" + docker pull t3docs/render-documentation + source <(docker run --rm t3docs/render-documentation show-shell-commands); dockrun_t3rd makehtml + xdg-open "Documentation-GENERATED-temp/Result/project/0.0.0/Index.html" \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000000000000000000000000000000000000..5e657c5fd0a42e3d52a2004121f119911d74c129 --- /dev/null +++ b/composer.json @@ -0,0 +1,5 @@ +{ + "require": { + "typo3/cms-core": "^8.7" + } +} diff --git a/docker/_helper_functions.sh b/docker/_helper_functions.sh new file mode 100644 index 0000000000000000000000000000000000000000..1f10838588dc69f47fa26f81457b13feeda0d6a9 --- /dev/null +++ b/docker/_helper_functions.sh @@ -0,0 +1,37 @@ +#!/bin/bash -ex + +function getHostPort() +{ + local CONTAINER_PORT="$1" + local CONTAINER="$2" + echo $(docker inspect -f "{{ (index (index .NetworkSettings.Ports \"${CONTAINER_PORT}/tcp\") 0).HostPort }}" $CONTAINER) +} +function removeContainerAfterTimeout() +{ + local TIMEOUT="$1" + local CONTAINER="$2" + (sleep ${TIMEOUT} && docker rm -f ${CONTAINER})& + disown +} +function makePathExecutable() +( +cd "$(dirname "$1")" +while [[ "$PWD" != "/" ]] +do + echo "make $PWD executable" + chmod o+x . || true + cd .. +done +) +function getContainerName() +{ + local CONTAINER="$1" + local CONTAINER_NAME=$(docker inspect --format="{{.Name}}" ${CONTAINER}) + echo ${CONTAINER_NAME:1} +} +function addUsernameToContainerName() +{ + local CONTAINER="$1" + local CONTAINER_NAME=$(getContainerName ${CONTAINER}) + docker rename ${CONTAINER_NAME} ${USER}_${CONTAINER_NAME} +} diff --git a/extension/Documentation/Links.rst b/extension/Documentation/Links.rst deleted file mode 100644 index 2424aeee401a86d963298a996c32533e96e80978..0000000000000000000000000000000000000000 --- a/extension/Documentation/Links.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: Includes.txt - - -.. _links: - -Links ------ - -:TER: - https://typo3.org/extensions/repository/view/ - -:Bug Tracker: - https://forge.typo3.org/projects/extension-/issues - -:Git Repository: - https://github.com// - -:Contact: - `@ `__ diff --git a/extension/Documentation/README.rst b/extension/Documentation/README.rst deleted file mode 100644 index 59177b6ff82467bf41657393e687cda4aa7cd40c..0000000000000000000000000000000000000000 --- a/extension/Documentation/README.rst +++ /dev/null @@ -1,8 +0,0 @@ -========================================= -TYPO3 Documentation Starter "Public Info" -========================================= - -:Repository: https://github.com/T3DocumentationStarter/Public-Info-053 -:Published at: https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/ -:Writing here: Carsten Rose - diff --git a/extension/Documentation/Settings.cfg b/extension/Documentation/Settings.cfg deleted file mode 100644 index d23eaf152c3693054f89cf650990df04ce9eb77e..0000000000000000000000000000000000000000 --- a/extension/Documentation/Settings.cfg +++ /dev/null @@ -1,157 +0,0 @@ - -[general] - -project = QFQ - Quick Form Query -version = 19.5 -release = 19.5.1 -t3author = Carsten Rose -copyright = since 2017 by the author - -description = Documentation for the Typo3 Extension 'QFQ' - - -; defaults: -# highlight_language = 'php' -# html_use_smartypants = False -# language = None -# master_doc = 'Index' -# pygments_style = 'sphinx' -# source_suffix = ['.rst', '.md'] -# todo_include_todos = False - - -[notify] - -about_new_build = carsten.rose@math.uzh.ch - - -[html_theme_options] - -; for theme t3SphinxThemeRtd - -# to get the "Edit me on Github Button" -github_branch = master -github_repository = T3DocumentationStarter/Public-Info-053 - -# planned -github_commit_hash = -github_revision_msg = - -# planned -github_sphinx_locale = - -# Fille in values to get links in the "Related Links" section at the lower left -project_contact = mailto:carsten.rose@math.uzh.ch -project_discussions = -project_home = https://github.com/T3DocumentationStarter/Public-Info-053 -project_issues = https://github.com/T3DocumentationStarter/Public-Info-053/issues -project_repository = https://github.com/T3DocumentationStarter/Public-Info-053 - -# leave this empty -use_opensearch = - - -[intersphinx_mapping] - -; in this manual we actually use: - -# t3api = http://typo3.org/api/typo3cms/ -# t3coreapi = http://docs.typo3.org/TYPO3/CoreApiReference -# t3tsconfig = http://docs.typo3.org/typo3cms/TSconfigReference -# t3tssyntax = http://docs.typo3.org/typo3cms/TyposcriptSyntaxReference - -# t3api = https://typo3.org/api/typo3cms/ -# t3cgl = https://docs.typo3.org/typo3cms/CodingGuidelinesReference/ -# t3coreapi = https://docs.typo3.org/typo3cms/CoreApiReference/ -# t3editors = https://docs.typo3.org/typo3cms/EditorsTutorial/ -# t3extbasebook = https://docs.typo3.org/typo3cms/ExtbaseFluidBook/ -# t3fal = https://docs.typo3.org/typo3cms/FileAbstractionLayerReference/ -# t3inside = https://docs.typo3.org/typo3cms/InsideTypo3Reference/ -# t3install = https://docs.typo3.org/typo3cms/InstallationGuide/ -# t3l10n = https://docs.typo3.org/typo3cms/FrontendLocalizationGuide/ -# t3security = https://docs.typo3.org/typo3cms/SecurityGuide/ -# t3services = https://docs.typo3.org/typo3cms/Typo3ServicesReference/ -# t3skinning = https://docs.typo3.org/typo3cms/SkinningReference/ -# t3start = https://docs.typo3.org/typo3cms/GettingStartedTutorial/ -# t3tca = https://docs.typo3.org/typo3cms/TCAReference/ -# t3templating = https://docs.typo3.org/typo3cms/TemplatingTutorial/ -# t3ts45 = https://docs.typo3.org/typo3cms/TyposcriptIn45MinutesTutorial/ -# t3tsconfig = https://docs.typo3.org/typo3cms/TSconfigReference/ -# t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference/ -# t3tssyntax = https://docs.typo3.org/typo3cms/TyposcriptSyntaxReference/ - - -# [extensions] -# -# ; Add to list of extensions[] as defined in 'conf.py'. -# ; Mention the extensions you need. Some are loaded automatically -# ; and don't need to be mentioned. Examples: -# -# any_name_1 = sphinx.ext.extlinks -# any_name_2 = sphinx.ext.ifconfig -# any_name_3 = sphinx.ext.intersphinx - - -# [extlinks] -# -# ; These defaults are set in conf.py -# -# ; Example: -# ; :forge:`12345` will be rendered as -# ; Forge #12345 -# -# ; name = url | prefix -# -# forge = https://forge.typo3.org/issues/%s | Forge # -# issue = https://forge.typo3.org/issues/%s | Issue # -# review = https://review.typo3.org/%s' | Review # - - -# [latex_documents] -# -# ; These defaults are set in conf.py -# -# source_start_file = (master_doc) ; "Index" -# target_name = PROJECT.tex -# title = (project) -# author = (t3author) -# documentclass = "manual" - - - -# [latex_elements] -# -# ; These defaults are set conf.py -# -# papersize = a4paper ; letterpaper | a4paper -# pointsize = 10pt ; 10pt | 11pt | 12pt -# preamble = \\usepackage{typo3} ; Additional stuff for the LaTeX preamble. -# -# ; for more see: # for more see: http://sphinx-doc.org/config.html#confval-latex_elements - - - -# [texinfo_documents] -# -# ; These defaults are set in conf.py -# -# source_start_file = (master_doc) ; 'Index' -# target_name = (t3shortname) -# title = (project) -# author = (t3author) -# dir_menu_entry = (project) -# description = (description) or 'This is project (project)' -# category = Miscellaneous - - - -# [man_pages] -# -# ; These defaults are set in conf.py -# -# source_start_file = (master_doc) ; 'Index' -# name = (project) -# description = (description) or 'This is project (project)' -# authors = (t3author) -# manual_section = 1 - diff --git a/extension/Documentation/_make/Makefile b/extension/Documentation/_make/Makefile deleted file mode 100644 index 6f01d8c1f3131951fc6d5740c69798c5d5cda647..0000000000000000000000000000000000000000 --- a/extension/Documentation/_make/Makefile +++ /dev/null @@ -1,180 +0,0 @@ -# You can set these variables from the command line. -SPHINXOPTS = -c . -a -E -w ./_not_versioned/warnings.txt -SPHINXBUILD = sphinx-build -PAPER = a4 -BUILDDIR = build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .. -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .. - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " pdf to make PDF using rst2pdf" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/QFQ Extension.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/QFQ Extension.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/QFQ Extension" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/QFQ Extension" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -pdf: - $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf - @echo - @echo "Build finished. The PDF is in $(BUILDDIR)/pdf." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/extension/Documentation/_make/_not_versioned/.gitignore b/extension/Documentation/_make/_not_versioned/.gitignore deleted file mode 100644 index cb5432f73f0182e2c3eb051ae6e292536bb2c52e..0000000000000000000000000000000000000000 --- a/extension/Documentation/_make/_not_versioned/.gitignore +++ /dev/null @@ -1 +0,0 @@ -warnings.txt diff --git a/extension/Documentation/_make/conf.py b/extension/Documentation/_make/conf.py deleted file mode 100644 index 221450540d8b6a033fd7225775aef53ee30baba0..0000000000000000000000000000000000000000 --- a/extension/Documentation/_make/conf.py +++ /dev/null @@ -1,435 +0,0 @@ -# -*- coding: utf-8 -*- -# -# QFQ Extension documentation build configuration file, created by -# TYPO3 extension sphinx on Wed, 02 Mar 2016 15:30:57 +0100. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- PHP highlighting configuration -------------------------------------------- - -from sphinx.highlighting import lexers -if lexers: - from pygments.lexers.web import PhpLexer - lexers['php'] = PhpLexer(startinline=True) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.ifconfig'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['../_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'Index' - -# General information about the project. -project = u'QFQ Extension' -copyright = u'2017, Carsten Rose' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents.lease -# -# The short X.Y version. -version = '19.5' -# The full version, including alpha/beta/rc tags. -release = '19.5.1' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -today_fmt = '%Y-%m-%d %H:%M' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_make'] -exclude_trees = ['_make'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['../_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'qfqdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -'preamble': '\\usepackage{typo3}' -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('Index', 'qfq.tex', u'QFQ Extension', - u'Carsten Rose', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for rst2pdf output ------------------------------------------------ - -# Grouping the document tree into PDF files. List of tuples -# (source start file, target name, title, author, options). -# -# If there is more than one author, separate them with \\. -# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor' -# -# The options element is a dictionary that lets you override -# this config per-document. -# For example, -# ('index', u'MyProject', u'My Project', u'Author Name', -# dict(pdf_compressed = True)) -# would mean that specific document would be compressed -# regardless of the global pdf_compressed setting. -pdf_documents = [ - ('Index', 'qfq', u'QFQ Extension', - u'Carsten Rose'), -] - -# A comma-separated list of custom stylesheets. Example: -pdf_stylesheets = ['sphinx','kerning','a4'] - -# A list of folders to search for stylesheets. Example: -pdf_style_path = ['.', '_styles'] - -# Create a compressed PDF -# Use True/False or 1/0 -# Example: compressed=True -#pdf_compressed = False - -# A colon-separated list of folders to search for fonts. Example: -# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/'] - -# Language to be used for hyphenation support -#pdf_language = "en_US" - -# Mode for literal blocks wider than the frame. Can be -# overflow, shrink or truncate -#pdf_fit_mode = "shrink" - -# Section level that forces a break page. -# For example: 1 means top-level sections start in a new page -# 0 means disabled -#pdf_break_level = 0 - -# When a section starts in a new page, force it to be 'even', 'odd', -# or just use 'any' -#pdf_breakside = 'any' - -# Insert footnotes where they are defined instead of -# at the end. -#pdf_inline_footnotes = True - -# verbosity level. 0 1 or 2 -#pdf_verbosity = 0 - -# If false, no index is generated. -#pdf_use_index = True - -# If false, no modindex is generated. -#pdf_use_modindex = True - -# If false, no coverpage is generated. -#pdf_use_coverpage = True - -# Name of the cover page template to use -#pdf_cover_template = 'sphinxcover.tmpl' - -# Documents to append as an appendix to all manuals. -#pdf_appendices = [] - -# Enable experimental feature to split table cells. Use it -# if you get "DelayedTable too big" errors -#pdf_splittables = False - -# Set the default DPI for images -#pdf_default_dpi = 72 - -# Enable rst2pdf extension modules (default is only vectorpdf) -# you need vectorpdf if you want to use sphinx's graphviz support -#pdf_extensions = ['vectorpdf'] - -# Page template name for "regular" pages -#pdf_page_template = 'cutePage' - -# Show Table Of Contents at the beginning? -#pdf_use_toc = True - -# How many levels deep should the table of contents be? -pdf_toc_depth = 9999 - -# Add section number to section references -pdf_use_numbered_links = False - -# Background images fitting mode -pdf_fit_background_mode = 'scale' - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('Index', 'qfq', u'QFQ Extension', - [u'Carsten Rose'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('Index', 'qfq', u'QFQ Extension', - u'Carsten Rose', 'QFQ Extension', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - - -#================================================= -# -# TYPO3 codeblock BEGIN: -# -# Insert this codeblock at the end of your Sphinx -# builder configuration file 'conf.py'. -# This may enable TYPO3 specific features like -# TYPO3 themes. It makes Yaml settings files work. -# -#------------------------------------------------- - -if 1 and "TYPO3 specific": - - try: - t3DocTeam - except NameError: - t3DocTeam = {} - - try: - import t3sphinx - html_theme_path.insert(0, t3sphinx.themes_dir) - html_theme = 'typo3sphinx' - except: - html_theme = 'default' - - t3DocTeam['conf_py_file'] = None - try: - t3DocTeam['conf_py_file'] = __file__ - except: - import inspect - t3DocTeam['conf_py_file'] = inspect.getfile( - inspect.currentframe()) - - t3DocTeam['conf_py_package_dir'] = os.path.abspath(os.path.dirname( - t3DocTeam['conf_py_file'])) - t3DocTeam['relpath_to_master_doc'] = '..' - t3DocTeam['relpath_to_logdir'] = '_not_versioned' - t3DocTeam['path_to_logdir'] = os.path.join( - t3DocTeam['conf_py_package_dir'], - t3DocTeam['relpath_to_logdir']) - t3DocTeam['pathToYamlSettings'] = os.path.join( - t3DocTeam['conf_py_package_dir'], - t3DocTeam['relpath_to_master_doc'], 'Settings.yml') - try: - t3DocTeam['pathToGlobalYamlSettings'] = \ - t3sphinx.pathToGlobalYamlSettings - except: - t3DocTeam['pathToGlobalYamlSettings'] = None - if not t3DocTeam['pathToGlobalYamlSettings']: - t3DocTeam['pathToGlobalYamlSettings'] = os.path.join( - t3DocTeam['conf_py_package_dir'], 'GlobalSettings.yml') - try: - __function = t3sphinx.yamlsettings.processYamlSettings - except: - __function = None - if not __function: - try: - import yamlsettings - __function = yamlsettings.processYamlSettings - except: - __function = None - if __function: - __function(globals(), t3DocTeam) - -#------------------------------------------------- -# -# TYPO3 codeblock END. -# -#=================================================