Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace Sphinx with new Typo3 documentation variant #286

Merged
merged 11 commits into from
May 28, 2024

Conversation

markusweigelt
Copy link
Contributor

@markusweigelt markusweigelt commented May 24, 2024

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

… to document Typo3 project, Cleanup legacy code
@markusweigelt markusweigelt added the 🛠️ maintenance A task to keep the code up-to-date and manageable. label May 24, 2024
@beatrycze-volk
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor

Congratulations on your first contribution to DFG Viewer! :)

@beatrycze-volk beatrycze-volk merged commit 3a5a9b3 into slub:master May 28, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🛠️ maintenance A task to keep the code up-to-date and manageable.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants