Commit c7827d37 authored by Carsten  Rose's avatar Carsten Rose
Browse files

Documentation: new 'make html'

parent 912de75a
......@@ -4,9 +4,12 @@ PKG_VERSION = $(shell awk '/version/ { print $$3 }' extension/ext_emconf.php |
NIGHTLY_DATE = $(shell date '+%Y%m%d')
EXTENSION_CONTENT = Classes Configuration qfq Resources ext_emconf.php ext_localconf.php ext_tables.php config.example.ini
all: archive
all: archive t3sphinx
doc: phpdoc jsdoc
doc: phpdoc jsdoc t3sphinx
t3sphinx:
cd extension/Documentation/_make; make html
support:
mkdir support
......
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/AdministratorManual/Index.rst:39: SEVERE: Unexpected section title.
FAQ
^^^
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/AdministratorManual/Index.rst:29: ERROR: Figure caption must be a paragraph or empty comment.
.. figure:: ../Images/AdministratorManual/ExtensionManager.png
:width: 500px
:alt: Extension Manager
Extension Manager (caption of the image)
List of extensions within the Extension Manager also shortend as "EM" (legend of the image)
FAQ
^^^
Possible subsection: FAQ
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/AdministratorManual/Index.rst:None: WARNING: image file not readable: AdministratorManual/../Images/AdministratorManual/ExtensionManager.png:width:500px:alt:ExtensionManager
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/ :maxdepth: 3'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/ :titlesonly:'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/.. Introduction/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/.. UsersManual/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.de_DE.tmpl/.. AdministratorManual/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:13: WARNING: duplicate label start, other instance in /home/a/crose/PhpstormProjects/qfq/extension/Documentation/Index.rst
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/ :maxdepth: 3'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/ :titlesonly:'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/.. Introduction/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/.. UsersManual/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:54: WARNING: toctree contains reference to nonexisting document u'Localization.fr_FR.tmpl/.. AdministratorManual/Index'
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:13: WARNING: duplicate label start, other instance in /home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.de_DE.tmpl/Index.rst:: WARNING: document isn't included in any toctree
/home/a/crose/PhpstormProjects/qfq/extension/Documentation/Localization.fr_FR.tmpl/Index.rst:: WARNING: document isn't included in any toctree
......
......@@ -73,21 +73,8 @@
<p>How should the extension be set up? E.g. is there a static template to include?</p>
<div class="figure">
<a class="reference internal image-reference" href="../_images/ExtensionManager.png"><img
alt="Extension Manager" src="../_images/ExtensionManager.png"
style="width: 500px;"/></a>
<p class="caption">Extension Manager (caption of the image)</p>
<div class="legend">
List of extensions within the Extension Manager also shortend as &#8220;EM&#8221;
(legend of the image)
</div>
</div>
<div class="section" id="faq">
<h3>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline"></a></h3>
<p>Possible subsection: FAQ</p>
<img alt="AdministratorManual/../Images/AdministratorManual/ExtensionManager.png:width:500px:alt:ExtensionManager"
src="AdministratorManual/../Images/AdministratorManual/ExtensionManager.png:width:500px:alt:ExtensionManager"/>
</div>
</div>
</div>
......@@ -102,11 +89,7 @@
<ul>
<li><a class="reference internal" href="#">Administrator Manual</a>
<ul>
<li><a class="reference internal" href="#installation">Installation</a>
<ul>
<li><a class="reference internal" href="#faq">FAQ</a></li>
</ul>
</li>
<li><a class="reference internal" href="#installation">Installation</a></li>
</ul>
</li>
</ul>
......@@ -142,7 +125,7 @@
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
......
......@@ -97,7 +97,7 @@
</tr>
<tr class="field-even field">
<th class="field-name">Rendered:</th>
<td class="field-body">2016-03-02 16:02</td>
<td class="field-body">2016-03-02 20:19</td>
</tr>
</tbody>
</table>
......@@ -159,7 +159,7 @@
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
......
......@@ -116,7 +116,7 @@
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
......
......@@ -115,7 +115,7 @@
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
......
......@@ -96,7 +96,7 @@
</tr>
<tr class="field-even field">
<th class="field-name">Gerendert:</th>
<td class="field-body">2016-03-02 16:02</td>
<td class="field-body">2016-03-02 20:19</td>
</tr>
</tbody>
</table>
......@@ -140,7 +140,7 @@
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
......
......@@ -93,7 +93,7 @@
</tr>
<tr class="field-even field">
<th class="field-name">Généré:</th>
<td class="field-body">2016-03-02 16:02</td>
<td class="field-body">2016-03-02 20:19</td>
</tr>
</tbody>
</table>
......@@ -137,7 +137,7 @@
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
......
......@@ -158,7 +158,7 @@
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
......
......@@ -30,12 +30,12 @@ How should the extension be set up? E.g. is there a static template to include?
:width: 500px
:alt: Extension Manager
Extension Manager (caption of the image)
Extension Manager (caption of the image)
List of extensions within the Extension Manager also shortend as "EM" (legend of the image)
List of extensions within the Extension Manager also shortend as "EM" (legend of the image)
FAQ
^^^
FAQ
^^^
Possible subsection: FAQ
Possible subsection: FAQ
......@@ -15,35 +15,35 @@ QFQ Extension
.. only:: html
:Classification:
extension_key
extension_key
:Version:
|release|
:Version:
|release|
:Language:
en
en
:Description:
enter description.
:Description:
enter description.
:Keywords:
comma,separated,list,keywords
:Keywords:
comma,separated,list,keywords
:Copyright:
2016
:Copyright:
2016
:Author:
Rafael Ostertag
:Author:
Rafael Ostertag
:Email:
author@example.com
:Email:
author@example.com
:License:
This document is published under the Open Publication License
available from http://www.opencontent.org/openpub/
:License:
This document is published under the Open Publication License
available from http://www.opencontent.org/openpub/
:Rendered:
|today|
|today|
The content of this document is related to TYPO3,
a GNU/GPL CMS/Framework available from `www.typo3.org <https://typo3.org/>`__.
......@@ -55,7 +55,7 @@ QFQ Extension
:maxdepth: 3
:titlesonly:
Introduction/Index
UsersManual/Index
AdministratorManual/Index
Links
Introduction/Index
UsersManual/Index
AdministratorManual/Index
Links
......@@ -19,6 +19,6 @@ Here should be given a brief overview of the extension. What does it do? What pr
:width: 500px
:alt: Introduction Package
Introduction Package just after installation (caption of the image)
Introduction Package just after installation (caption of the image)
How the Frontend of the Introduction Package looks like just after installation (legend of the image)
How the Frontend of the Introduction Package looks like just after installation (legend of the image)
......@@ -12,13 +12,13 @@ Links
-----
:TER:
https://typo3.org/extensions/repository/view/<extension key>
https://typo3.org/extensions/repository/view/<extension key>
:Bug Tracker:
https://forge.typo3.org/projects/extension-<extension key>/issues
https://forge.typo3.org/projects/extension-<extension key>/issues
:Git Repository:
https://github.com/<username>/<extension key>
https://github.com/<username>/<extension key>
:Contact:
`@<username> <https://twitter.com/your-username>`__
`@<username> <https://twitter.com/your-username>`__
......@@ -15,35 +15,35 @@ QFQ Extension (Deutsch)
.. only:: html
:Klassifikation:
extension_key
extension_key
:Version:
|release|
:Version:
|release|
:Sprache:
de
de
:Beschreibung:
Geben Sie eine Beschreibung ein.
:Beschreibung:
Geben Sie eine Beschreibung ein.
:Schlüsselwörter:
komma-getrennte,Liste,von,Schlüsselwörtern
:Schlüsselwörter:
komma-getrennte,Liste,von,Schlüsselwörtern
:Copyright:
2016
:Copyright:
2016
:Autor:
Rafael Ostertag
:Autor:
Rafael Ostertag
:E-Mail:
author@example.com
:E-Mail:
author@example.com
:Lizenz:
Dieses Dokument wird unter der Open Content License, siehe
http://www.opencontent.org/opl.shtml veröffentlicht.
:Lizenz:
Dieses Dokument wird unter der Open Content License, siehe
http://www.opencontent.org/opl.shtml veröffentlicht.
:Gerendert:
|today|
|today|
Der Inhalt dieses Dokuments bezieht sich auf TYPO3,
ein GNU/GPL CMS-Framework auf `www.typo3.org <https://typo3.org/>`__.
......@@ -55,6 +55,6 @@ QFQ Extension (Deutsch)
:maxdepth: 3
:titlesonly:
.. Introduction/Index
.. UsersManual/Index
.. AdministratorManual/Index
.. Introduction/Index
.. UsersManual/Index
.. AdministratorManual/Index
......@@ -15,35 +15,35 @@ QFQ Extension (Français)
.. only:: html
:Classification:
extension_key
extension_key
:Version:
|release|
:Version:
|release|
:Langue:
fr
fr
:Description:
entrez une description.
:Description:
entrez une description.
:Mots-clés:
list,mots-clés,séparés,par,virgules
:Mots-clés:
list,mots-clés,séparés,par,virgules
:Copyright:
2016
:Copyright:
2016
:Auteur:
Rafael Ostertag
:Auteur:
Rafael Ostertag
:E-mail:
author@example.com
:E-mail:
author@example.com
:Licence:
Ce document est publié sous la licence de contenu libre
disponible sur http://www.opencontent.org/opl.shtml
:Licence:
Ce document est publié sous la licence de contenu libre
disponible sur http://www.opencontent.org/opl.shtml
:Généré:
|today|
|today|
Le contenu de ce document est en relation avec TYPO3,
un CMS/Framework GNU/GPL disponible sur `www.typo3.org <https://typo3.org/>`__.
......@@ -55,6 +55,6 @@ QFQ Extension (Français)
:maxdepth: 3
:titlesonly:
.. Introduction/Index
.. UsersManual/Index
.. AdministratorManual/Index
.. Introduction/Index
.. UsersManual/Index
.. AdministratorManual/Index
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment