Skip to content

Commit 25392cf

Browse files
authored
Remove tools section from extension documentation (#5481)
* Apply CGL * Remove tools section from extension documentation
1 parent 372502c commit 25392cf

File tree

1 file changed

+19
-32
lines changed

1 file changed

+19
-32
lines changed
Lines changed: 19 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
.. include:: /Includes.rst.txt
2-
.. index::
3-
Extension development; Documentation
4-
Path; EXT:{extkey}/Documentation/
5-
.. _extension-documentation:
6-
.. _extension-documentation-sphinx:
7-
.. _extension-documentation-readme:
1+
.. include:: /Includes.rst.txt
2+
.. index::
3+
Extension development; Documentation
4+
Path; EXT:{extkey}/Documentation/
5+
.. _extension-documentation:
6+
.. _extension-documentation-sphinx:
7+
.. _extension-documentation-readme:
8+
.. _extension-documentation-tools:
89

910
====================
1011
Adding documentation
@@ -19,35 +20,21 @@ extension.
1920
The TYPO3 documentation platform https://docs.typo3.org centralizes documentation
2021
for each project. It supports different types of documentation:
2122

22-
#. The *full documentation*, stored in :file:`EXT:{extkey}/Documentation/`.
23-
#. The *single file documentation*, such as a simple README file stored in
24-
:file:`EXT:{extkey}/README.rst`.
23+
#. The *full documentation*, stored in :file:`EXT:{extkey}/Documentation/`.
24+
#. The *single file documentation*, such as a simple README file stored in
25+
:file:`EXT:{extkey}/README.rst`.
2526

2627
We recommend the first approach for the following reasons:
2728

28-
- **Output formats:** Full documentations can be automatically rendered as HTML
29-
or TYPO3-branded PDF.
30-
- **Cross-references:** It is easy to cross-reference to other chapters and
31-
sections of other manuals (either TYPO3 references or extension manuals).
32-
The links are automatically updated when pages or sections are moved.
33-
- **Many content elements:** The Sphinx template used for rendering the full
34-
documentation provides many useful content elements to improve the structure
35-
and look of your documentation.
29+
- **Output formats:** Full documentations can be automatically rendered as HTML
30+
or TYPO3-branded PDF.
31+
- **Cross-references:** It is easy to cross-reference to other chapters and
32+
sections of other manuals (either TYPO3 references or extension manuals).
33+
The links are automatically updated when pages or sections are moved.
34+
- **Many content elements:** The Sphinx template used for rendering the full
35+
documentation provides many useful content elements to improve the structure
36+
and look of your documentation.
3637

3738
For more details on both approaches see the :ref:`File structure <h2document:file-structure>`
3839
page and for more information on writing TYPO3 documentation in general, see the
3940
:ref:`Writing documentation <h2document:start>` guide.
40-
41-
.. _extension-documentation-tools:
42-
43-
Tools
44-
=====
45-
46-
Although it is possible to write every single line of a full documentation
47-
from scratch, the TYPO3 community provides tools to support you:
48-
49-
- A `Sample Manual <https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual>`_
50-
is available to be immediately copied into your own extension.
51-
- The :composer:`friendsoftypo3/extension-builder`
52-
optionally generates a documentation skeleton together with the extension
53-
skeleton.

0 commit comments

Comments
 (0)