Replace Sphinx with new Typo3 documentation variant

slub / dfg-viewer

The DFG Viewer is a free web service for browsing digitized books from remote library repositories in a rich and dynamic environment.

https://dfg-viewer.de

GNU General Public License v3.0

29 stars 26 forks source link

Replace Sphinx with new Typo3 documentation variant #286

Closed markusweigelt closed 1 month ago

markusweigelt commented 1 month ago

Since the beginning of 2024 you can switch to the new, PHP-based reStructured Text rendering to try it out. The new rendering will become mandatory in August 2024.

https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Migration/Index.html

What does PR do?

migrate legacy Sphinx to PHP based rendering
adjust developer documentation
remove legacy code and files
GitHub workflow to check documentation files

More informations: https://docs.typo3.org/other/t3docs/render-guides/main/en-us/Introduction/Index.html

beatrycze-volk commented 1 month ago

Small suggestion, use the Draft option if you have opened PR and then observed that there are still some missing parts or you want to included some changes. After you are done with changing, you mark the PR as ready for review :)

markusweigelt commented 1 month ago

Alright, that was an exception. I had adjusted the documentation generation for Kitodo.Presentation, and then I noticed a few more things. Actually, I was done. Next time, I'll use the Draft PR. ;)

beatrycze-volk commented 1 month ago

Congratulations on your first contribution to DFG Viewer! :)