mirror of
https://github.com/FriendsOfTYPO3/tea.git
synced 2024-11-24 20:16:13 +01:00
9b4c0a8f50
Command for rendering:
./Build/Scripts/runTests.sh -s docsGenerate
or just:
composer docs:generate
The reference to the TYPO3 Documentation Rendering Guide was adjusted as the Quickstart page does not exist anymore.
Additionally, the genindex isn't supported anymore. It is planned to consider the `index` directive in the global search on docs.typo3.org.
Resolves: #1189
22 lines
548 B
ReStructuredText
22 lines
548 B
ReStructuredText
.. include:: /Includes.rst.txt
|
|
|
|
.. _documentation:
|
|
|
|
=======================
|
|
Documentation rendering
|
|
=======================
|
|
|
|
In order to render the documentation, this extension provides a Composer script
|
|
that you can run locally via
|
|
|
|
.. index:: Commands; composer docs:generate
|
|
.. code-block:: bash
|
|
|
|
composer docs:generate
|
|
|
|
You do not need to start or build the containers for this as this happens
|
|
automatically.
|
|
|
|
.. seealso::
|
|
|
|
For further details read the :ref:`TYPO3 Documentation Rendering Guide <h2document:docs-contribute-git-docker>`.
|