Skip to content

Commit

Permalink
[DOCS] Rearrange Makefile sections and local rendering in Update Inde…
Browse files Browse the repository at this point in the history
…x.rst

Make the reason for creating the file Makefile more apparent. Try to keep the central idea of a Makefile and how it fits into the whole context.
  • Loading branch information
Alagts authored Jul 22, 2024
1 parent 20a55c1 commit d99fa33
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions Documentation/Migration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,6 @@ everything went well. They can be ignored since these files are usually files th
not need to be converted. You can now delete :file:`Settings.cfg`. If you ever should need it again it is still in the Git history. Also delete
file :file:`genindex.rst` in your Documentation directory (if available).

Try out the rendering locally
=============================

Use our Docker container to render your documentation locally. Read more about it in
:ref:`local rendering <rendering-docs>`.

.. _migrate-detailed-steps:

Expand Down Expand Up @@ -179,11 +174,20 @@ PHP-based rendering tool:
rendering, and every file that is just a code snippet placed in an external file
should be renamed to use a :file:`.rst.txt` extension instead.

Recommendations
===============

Render your Documentation files locally
=======================================

Use our Docker container to render your documentation locally. Read more about it in
:ref:`local rendering <rendering-docs>`.

The following list is not a requirement to utilize the PHP-based rendering, but
follows "best practice" to make the most of your documentation project.
One of the most benefits is that it simplifies finding
:ref:`errors <h2document:migrate-possible-errors>` in your rst code.
The :file:`Makefile` helps you to launch the local rendering described in :ref:`here <rendering-docs>`.
You create the :file:`Makefile` in order to register the command shortcuts that you
would use to :ref:`render your Documentation locally <rendering-docs>`.

.. _migrate-to-makefile:

Expand Down

0 comments on commit d99fa33

Please sign in to comment.