-
Notifications
You must be signed in to change notification settings - Fork 76
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 (#519)
- Loading branch information
Showing
8 changed files
with
52 additions
and
108 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,37 +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:: fluid(code) | ||
:class: html | ||
|
||
.. 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 |
---|---|---|
|
@@ -57,4 +57,3 @@ output those in various ways: | |
:hidden: | ||
|
||
Sitemap | ||
genindex |
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
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,19 @@ | ||
<?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://extensions.typo3.org/extension/tt_address" | ||
project-contact="https://typo3.slack.com/archives/C02AUJ7JJ" | ||
project-repository="https://github.com/FriendsOfTYPO3/tt_address" | ||
project-issues="https://github.com/FriendsOfTYPO3/tt_address/issues" | ||
edit-on-github-branch="master" | ||
edit-on-github="https://github.com/FriendsOfTYPO3/tt_address" | ||
typo3-core-preferred="stable" | ||
interlink-shortcode="friendsoftypo3/tt-address" | ||
/> | ||
<project title="Address List" | ||
release="main (development)" | ||
version="main (development)" | ||
copyright="since 2002 by the TYPO3 contributors"/> | ||
</guides> |
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,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 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 | ||
|
||
.PHONY: codesnippets | ||
codesnippets: ## Regenerate automatic code snippets | ||
.Build/vendor/bin/typo3 codesnippet:create Documentation/CodeSnippets/ |