-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Switch to PHP based documentation rendering (#968)
* Create guides.xml * Remove now outdated Settings.cfg * Remove outdated genindex.rst * Remove outdated screenshots.json * Introduce automatic testing for documentation changes * Introduce make file for easy local rendering
- Loading branch information
Showing
8 changed files
with
55 additions
and
1,631 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
name: test documentation | ||
|
||
on: [ push, pull_request ] | ||
|
||
jobs: | ||
tests: | ||
name: documentation | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Test if the documentation will render without warnings | ||
run: | | ||
mkdir -p Documentation-GENERATED-temp \ | ||
&& docker run --rm --pull always -v $(pwd):/project \ | ||
ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1 @@ | ||
.. More information about this file: | ||
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt | ||
.. ---------- | ||
.. text roles | ||
.. ---------- | ||
.. role:: aspect(emphasis) | ||
.. role:: bash(code) | ||
.. role:: html(code) | ||
.. role:: js(code) | ||
.. role:: php(code) | ||
.. role:: rst(code) | ||
.. role:: sep(strong) | ||
.. role:: sql(code) | ||
|
||
.. role:: tsconfig(code) | ||
:class: typoscript | ||
|
||
.. role:: typoscript(code) | ||
.. role:: xml(code) | ||
:class: html | ||
|
||
.. role:: yaml(code) | ||
|
||
.. default-role:: code | ||
|
||
.. --------- | ||
.. highlight | ||
.. --------- | ||
.. By default, code blocks use PHP syntax highlighting | ||
.. highlight:: php | ||
.. You can put central messages to display on all pages here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -50,4 +50,3 @@ This document is the complete reference of the *Table Configuration Array* | |
:hidden: | ||
|
||
Sitemap | ||
genindex |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<guides xmlns="https://www.phpdoc.org/guides" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd" | ||
links-are-relative="true"> | ||
<extension | ||
class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension" | ||
project-home="https://docs.typo3.org/m/typo3/reference-tca/main/en-us/" | ||
project-contact="https://typo3.slack.com/archives/C028JEPJL" | ||
project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA" | ||
project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA/issues" | ||
edit-on-github-branch="main" | ||
edit-on-github="TYPO3-Documentation/TYPO3CMS-Reference-TCA" | ||
typo3-core-preferred="main" | ||
/> | ||
<project title="TCA Reference" | ||
release="main (development)" | ||
version="main (development)" | ||
copyright="since 2012 by the TYPO3 contributors" | ||
/> | ||
</guides> |
Oops, something went wrong.