Skip to content

Commit

Permalink
[TASK] Improve note about automated migration
Browse files Browse the repository at this point in the history
  • Loading branch information
jaapio committed Nov 18, 2024
1 parent 77d48e7 commit 64ac026
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Documentation/Howto/Migration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@ Migration: From Sphinx to PHP-based rendering

.. note::

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.
Since November 2024 the official documentation rendering process has been
switched to a PHP-based rendering. When your documentation was configured
with Sphinx, the rendering process will be automatically switched to the
PHP-based rendering. The automatic migration will work for most cases, but
some manual adjustments might be necessary. This guide will help you to
migrate your documentation to the new rendering process.

The main difference compared to the Sphinx rendering is that the PHP-based rendering
requires a file called :file:`Documentation/guides.xml` for configuration.
Expand Down

0 comments on commit 64ac026

Please sign in to comment.