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.

Sign up for GitHub

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

Jump to bottom

[MAINTENANCE] Replace Sphinx with new Typo3 documentation variant #1213

Merged
merged 12 commits into from
May 28, 2024
Merged

[MAINTENANCE] Replace Sphinx with new Typo3 documentation variant #1213

merged 12 commits into from
May 28, 2024

Conversation

markusweigelt
Copy link
Contributor

@markusweigelt markusweigelt commented May 27, 2024 •
edited
Loading

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
  • Rename images cause images could not be assigned to new documentation
  • GitHub workflow to check documentation files for errors and warning
  • Bugfixes e.g. User Manual -> Indexing Documents -> Reindex collections table

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

@markusweigelt markusweigelt changed the title Replace Sphinx with new Typo3 documentation variant [MAINTENANCE] Replace Sphinx with new Typo3 documentation variant May 27, 2024
@sebastian-meyer sebastian-meyer self-requested a review May 28, 2024 06:37
@sebastian-meyer sebastian-meyer added 🛠 maintenance A task to keep the code up-to-date and manageable. 📖 documentation An update on documentation. labels May 28, 2024
sebastian-meyer
sebastian-meyer requested changes May 28, 2024
View reviewed changes
.github/workflows/documentation.yml Outdated Show resolved Hide resolved
.github/workflows/documentation.yml Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
Documentation/Plugins/Index.rst Outdated Show resolved Hide resolved
Documentation/guides.xml Outdated Show resolved Hide resolved
composer.lock Outdated Show resolved Hide resolved
@sebastian-meyer
Copy link
Member

Thank you very much! And congratulations on your first contribution to Kitodo.Presentation!

@sebastian-meyer sebastian-meyer merged commit 05a51cf into kitodo:master May 28, 2024
7 checks passed
sebastian-meyer added a commit that referenced this pull request May 29, 2024
@markusweigelt @sebastian-meyer
[MAINTENANCE] Replace Sphinx with new Typo3 documentation variant (#1213
9ccda0f 
)

Co-authored-by: Sebastian Meyer <[email protected]>
@markusweigelt markusweigelt deleted the replace-sphinx branch July 16, 2024 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sebastian-meyer sebastian-meyer sebastian-meyer approved these changes

Assignees

@markusweigelt markusweigelt

Labels
📖 documentation An update on documentation. 🛠 maintenance A task to keep the code up-to-date and manageable.
Projects
None yet
Milestone
Kitodo.Presentation 5.1.0
Development

Successfully merging this pull request may close these issues.
2 participants
@markusweigelt @sebastian-meyer