Skip to content

Commit

Permalink
!!![TASK] Render main with PHP based guides-rendering (#326)
Browse files Browse the repository at this point in the history
* [TASK] Try rendering with phpdocumentor/guides

* [TASK] Introduce Makefile

* [TASK] Transfer all settings to guides.xml

* [TASK] Add automatic tests
  • Loading branch information
linawolf authored Feb 18, 2024
1 parent e2bd232 commit af18258
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 98 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: test-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
36 changes: 2 additions & 34 deletions Documentation/Includes.rst.txt
Original file line number Diff line number Diff line change
@@ -1,34 +1,2 @@
.. 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
.. this file can be used to include information on the top of each page
.. for example to add a hint for outdated versions
64 changes: 0 additions & 64 deletions Documentation/Settings.cfg

This file was deleted.

27 changes: 27 additions & 0 deletions Documentation/guides.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?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"
>
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
edit-on-github="TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted"
edit-on-github-branch="documentation-draft"
typo3-core-preferred="main"
interlink-shortcode="t3start"
project-home="https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/"
project-contact="https://typo3.slack.com/archives/C028JEPJL"
project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted"
project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues"
/>
<project
title="Getting Started"
version="draft"
release="main"
copyright="since 2012 by the TYPO3 contributors"
/>
<inventory id="t3start11" url="https://docs.typo3.org/m/typo3/tutorial-getting-started/11.5/en-us/" />
<inventory id="t3start12" url="https://docs.typo3.org/m/typo3/tutorial-getting-started/12.4/en-us/" />
<inventory id="ext_surf" url="https://docs.typo3.org/other/typo3/surf/main/en-us/" />

</guides>
10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.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 docs (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

0 comments on commit af18258

Please sign in to comment.