Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

[TASK] Adapt to new PHP-based rendering #83

Merged
merged 4 commits into from
May 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
5 changes: 5 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,8 @@ trim_trailing_whitespace = true
indent_style = space
indent_size = 4
max_line_length = 80

# Makefile
[{Makefile,**.mk}]
# Use tabs for indentation (Makefiles require tabs)
indent_style = tab
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 @@ -58,4 +58,3 @@ Explained.
:hidden:

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

This file was deleted.

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

This file was deleted.

46 changes: 46 additions & 0 deletions Documentation/guides.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?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/tutorial-typoscript-in-45-minutes/main/en-us/"
project-contact="https://typo3.slack.com/archives/C028JEPJL"
project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Typoscript45Minutes"
project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Typoscript45Minutes/issues"
edit-on-github-branch="main"
edit-on-github="TYPO3-Documentation/TYPO3CMS-Tutorial-Typoscript45Minutes"
typo3-core-preferred="stable"
Alagts marked this conversation as resolved.
Show resolved Hide resolved
interlink-shortcode="typo3/tutorial-typoscript-in-45-minutes"
Alagts marked this conversation as resolved.
Show resolved Hide resolved
/>
<project title="TypoScript in 45 Minutes"
release="main (development)"
version="main (development)"
copyright="since 2012 by the TYPO3 contributors"
/>
<inventory id="t3coreapi"
url="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/"
/>
<inventory id="t3editors"
url="https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/"
/>
<inventory id="t3install"
url="https://docs.typo3.org/m/typo3/guide-installation/main/en-us/"
/>
<inventory id="t3sitepackage"
url="https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/"
/>
<inventory id="t3start"
url="https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/"
/>
<inventory id="t3tsconfig"
url="https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/"
/>
<inventory id="t3tsref"
url="https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/"
/>
<inventory id="ext_fsc"
url="https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/"
/>
</guides>
Alagts marked this conversation as resolved.
Show resolved Hide resolved
14 changes: 14 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.PHONY: help
help: ## Displays this list of targets with descriptions
@echo "The following commands are available:\n"
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'

.PHONY: docs
docs: ## Generate projects documentation (from "Documentation" directory)
mkdir -p Documentation-GENERATED-temp
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation

.PHONY: test-docs
test-docs: ## Test the documentation rendering
mkdir -p Documentation-GENERATED-temp
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log