FluidTYPO3 / vhs

TYPO3 extension VHS: Fluid ViewHelpers
https://fluidtypo3.org
Other
190 stars 229 forks source link

[TASK] Setup GitHub workflow "render-docs" #1771

Closed alexander-nitsche closed 1 year ago

alexander-nitsche commented 2 years ago

Automatically generate reST documentation files from the Fluid ViewHelpers implementation in Documentation/fluidtypo3/vhs/, commit and push.

This is inspired from the rendering workflow of the basic Fluid ViewHelpers documentation.

What i did:

  1. I tested the workflow by locally processing all steps and added the created documentation pages manually to the repository.
  2. I adapted the content structure to fit to the original Fluid ViewHelpers documentation.

What is missing:

  1. The fluid schema generator bug mentioned in this issue has to be fixed by someone with deeper Fluid knowledge.
  2. The workflow wording should be tested if (1) is fixed and the PR approved.

In the long run the Fluid documentation generator has to be adapted to generate proper reST. Currently it has some flaws.

alexander-nitsche commented 2 years ago

This is how the generated ViewHelpers pages look like: Screen Shot 2022-05-08 at 18 45 09

alexander-nitsche commented 2 years ago

In the long run the Fluid documentation generator has to be adapted to generate proper reST. Currently it has some flaws.

Is now handled in PR https://github.com/TYPO3-Documentation/fluid-documentation-generator/pull/5.

alexander-nitsche commented 2 years ago

I rebased the PR on the current development branch and re-enabled the automatic documentation rendering as the related issue has been fixed in meantime.

alexander-nitsche commented 1 year ago

Has been integrated in meantime by Claus.