Skip to content

Commit

Permalink
[TASK] Publish the PHP-based rendering to main
Browse files Browse the repository at this point in the history
  • Loading branch information
linawolf committed Apr 17, 2024
1 parent 176d065 commit a0bd911
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 5 deletions.
11 changes: 11 additions & 0 deletions Documentation/Includes.rst.txt
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
.. You can put central messages to display on all pages here
.. note::
This version of the guide covers the new PHP-based rendering of
Documentation with the TYPO3 Documentation theme.

If the project you are looking at has a file
:ref:`Documentation/guides.xml <guides-xml>` it is using the new rendering.

Otherwise, consider to :ref:`migrate <migrate>` the Documentation or head
over to the legacy version of this guide:
:ref:`How to document, Sphinx based <h2document-sphinx:start>`.
21 changes: 16 additions & 5 deletions Documentation/guides.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,20 @@
links-are-relative="true"
default-code-language="php"
>
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension" project-home="https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/" project-contact="https://typo3.slack.com/archives/C028JEPJL" project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument" project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/issues" edit-on-github-branch="main" edit-on-github="TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument"/>
<project title="Writing Documentation" release="main" version="main" copyright="since 2017 by the TYPO3 contributors"/>
<inventory id="t3home" url="https://docs.typo3.org/"/>
<inventory id="sphinx" url="https://www.sphinx-doc.org/en/master/"/>
<inventory id="t3sphinxtest" url="https://typo3-documentation.github.io/sphinx_typo3_theme_rendering_test/"/>
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
project-home="https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/"
project-contact="https://typo3.slack.com/archives/C028JEPJL"
project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument"
project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/issues"
edit-on-github-branch="main"
edit-on-github="TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument"
interlink-shortcode="h2document"
typo3-core-preferred="latest"
/>
<project title="Writing Documentation" release="main" version="main"
copyright="since 2017 by the TYPO3 contributors"/>
<inventory id="t3home" url="https://docs.typo3.org/"/>
<inventory id="sphinx" url="https://www.sphinx-doc.org/en/master/"/>
<inventory id="t3sphinxtest" url="https://typo3-documentation.github.io/sphinx_typo3_theme_rendering_test/"/>
<inventory id="h2document-sphinx" url="https://docs.typo3.org/m/typo3/docs-how-to-document/1.0/en-us/"/>
</guides>

0 comments on commit a0bd911

Please sign in to comment.