Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Documentation/Reference/GuidesXml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ And follow the interactive question.

The following settings can be relevant for TYPO3 themed documentation:

.. note::
The schema accepts a :xml:`theme` attribute on :xml:`<guides>`,
but TYPO3 documentation does not need it: the theme is loaded by
the :xml:`<extension class="...Typo3DocsThemeExtension">` tag. A
:xml:`<theme>` **child element** is invalid and aborts rendering
with `Invalid type for path guides.theme`.

.. _settings-guides-default-code-language:

.. confval:: default-code-language
Expand Down Expand Up @@ -137,6 +144,9 @@ And follow the interactive question.

<inventory id="sphinx" url="https://www.sphinx-doc.org/en/master/"/>

The :xml:`url` should end with a trailing slash (:xml:`.../en-us/`) —
without it, resolving the inventory can fail.


.. _settings-guides-project:

Expand Down Expand Up @@ -242,6 +252,12 @@ And follow the interactive question.
The class attribute is mandatory, it references the extension that is used
to render the documentation with the TYPO3 documentation theme.

.. note::
If the :xml:`class` attribute (or the whole :xml:`<extension>`
Comment thread
linawolf marked this conversation as resolved.
tag) is missing, the documentation renders with the default
phpDocumentor layout instead of the TYPO3 theme. No error is
raised — the output just looks wrong.

.. _settings-guides-github-workflow:

.. confval:: edit-on-github-*
Expand Down