Skip to content

Commit

Permalink
[TASK] Switch Documentation Rendering to PHP (#870)
Browse files Browse the repository at this point in the history
* [TASK] Switch Documentation Rendering to PHP

You can try out the rendering locally with
```
make docs
```

* Add export-ignore to Makefile

* Remove Makefile

You can try out the rendering locally with
```
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
```
  • Loading branch information
Alagts committed May 16, 2024
1 parent 6364ff8 commit 389ac38
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 36 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/test-documentation.yml
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
1 change: 0 additions & 1 deletion Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,3 @@ If using Fluid in combination with TYPO3 CMS, a look at the documentation of
:hidden:

Sitemap
genindex
28 changes: 0 additions & 28 deletions Documentation/Settings.cfg

This file was deleted.

7 changes: 0 additions & 7 deletions Documentation/genindex.rst

This file was deleted.

25 changes: 25 additions & 0 deletions Documentation/guides.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?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://packagist.org/packages/typo3fluid/fluid"
project-contact="https://typo3.slack.com/archives/C2MGJ7SJX"
project-repository="https://github.com/TYPO3/Fluid"
project-issues="https://github.com/TYPO3/Fluid/issues"
edit-on-github-branch="main"
edit-on-github="TYPO3/Fluid"
typo3-core-preferred="stable"
interlink-shortcode="typo3fluid/fluid"
/>
<project title="Fluid Rendering Engine"
release="main (development)"
version="main (development)"
copyright="since 2009 by the Fluid contributors"
/>
<inventory id="ext_fsc"
url="https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/"
/>
</guides>

0 comments on commit 389ac38

Please sign in to comment.