Skip to content

Commit

Permalink
[DOCS] Use new rendering configuration (#124)
Browse files Browse the repository at this point in the history
Also fixes some warnings.
  • Loading branch information
mabolek authored Jan 24, 2025
1 parent a53d833 commit bc0c02d
Show file tree
Hide file tree
Showing 9 changed files with 43 additions and 76 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,6 @@ indent_style = tab
# .htaccess
[.htaccess]
indent_style = tab

[Makefile]
indent_style = tab
6 changes: 0 additions & 6 deletions Documentation/Implementing/Extending/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,12 +158,8 @@ All are subclasses of :php:`FriendsOfTYPO3\Interest\DataHandling\Operation\Abstr
.. php:class:: AbstractConstructiveRecordOperation
.. php:currentnamespace:: FriendsOfTYPO3\Interest\DataHandling\Operation
.. php:class:: CreateRecordOperation
.. php:currentnamespace:: FriendsOfTYPO3\Interest\DataHandling\Operation
.. php:class:: UpdateRecordOperation
.. php:method:: __construct($recordRepresentation, $metaData)
Expand Down Expand Up @@ -365,8 +361,6 @@ All are subclasses of :php:`FriendsOfTYPO3\Interest\DataHandling\Operation\Abstr
:returntype: void

.. php:currentnamespace:: FriendsOfTYPO3\Interest\DataHandling\Operation
.. php:class:: DeleteRecordOperation
.. php:method:: __construct($recordRepresentation)
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Implementing/FileHandling/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Publicly accessible URL
Normal URL
^^^^^^^^^^

The default behavior is that the file specified in the `url` field is downloaded to the download location specified in the :ref:`persistence.fileUploadFolderPath` UserTS configuration parameter.
The default behavior is that the file specified in the `url` field is downloaded to the download location specified in the :ref:`persistence.fileUploadFolderPath <confval-persistence-fileuploadfolderpath>` UserTS configuration parameter.

With the extension's default configuration, this example will download the file at `https://example.com/image.png` to :file:`fileadmin/tx_interest/image.png`.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Implementing/Rest/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ will be "testuser:test1234" and the Base64-encoded version:
-H 'Authorization: basic dGVzdHVzZXI6dGVzdDEyMzQ=' \
-v 'https://example.org/rest/authenticate'
.. info::
.. note::

`authenticate` is a special endpoint used only for basic authentication
requests.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Implementing/Webhook/Index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: ../Includes.txt
.. include:: ../../Includes.txt

.. _reaction:

Expand Down
1 change: 0 additions & 1 deletion Documentation/Includes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@
.. role:: yaml(code)

.. default-role:: code
.. highlight:: guess
66 changes: 0 additions & 66 deletions Documentation/Settings.cfg

This file was deleted.

21 changes: 21 additions & 0 deletions Documentation/guides.xml
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://github.com/friendsoftypo3/interest"
project-contact="info@pixelant.net"
project-repository="https://github.com/friendsoftypo3/interest"
project-issues="https://github.com/friendsoftypo3/interest/issues"
edit-on-github-branch="master"
edit-on-github="friendsoftypo3/interest"
typo3-core-preferred="stable"
/>
<project title="Interest"
release="latest"
copyright="2023 by Pixelant.net"
/>
</guides>
16 changes: 16 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.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: 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 --minimal-test

0 comments on commit bc0c02d

Please sign in to comment.