Commit 014a3c4a authored by Carsten  Rose's avatar Carsten Rose
Browse files

Merge branch 'newdoc' into 'master'

Newdoc: docs.typo3.org seesm to fetch only the master branch - we need to merge to bring the doc online

See merge request !147
parents dbd51cc5 9ae6312f
Pipeline #1908 passed with stages
in 2 minutes and 41 seconds
# 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
# 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
......
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:
......
.. ==================================================
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
......
.. ==================================================
.. ==================================================
.. FOR YOUR INFORMATION TEST
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
......
.. 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/<username>/<extension key>
:TER:
https://typo3.org/extensions/repository/view/<extension key>
:Issues:
https://github.com/<username>/<extension key>/issues
:GitHub Repository:
https://github.com/<username>/<extension key>
:Contact:
`@<username> <https://twitter.com/your-username>`__
......@@ -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 <http://getbootstrap.com/>`_
.. 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)
..
......
# 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]
project = QFQ - Quick Form Query
; 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
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 =
# NOTE: Fill in YOUR values in the following!
# planned
github_sphinx_locale =
;github_branch = latest
;github_commit_hash =
;github_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/
;github_revision_msg =
;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
# 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 =
# 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
; 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/
......@@ -77,81 +76,7 @@ use_opensearch =
# 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/
# 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
# ; <a href="https://forge.typo3.org/issues/12345">Forge #12345</a>
#
# ; 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
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
{
"require": {
"typo3/cms-core": "^8.7"
}
}
#!/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}
}
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt
.. _links:
Links
-----
:TER:
https://typo3.org/extensions/repository/view/<extension key>
:Bug Tracker:
https://forge.typo3.org/projects/extension-<extension key>/issues
:Git Repository:
https://github.com/<username>/<extension key>
:Contact:
`@<username> <https://twitter.com/your-username>`__
=========================================
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
# 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 <target>' where <target> 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