Sphinx 8 support update

dmarteau · dmarteau · commit 54eda2ec46a4 · 2025-05-13T08:52:52.000+02:00
diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,6 @@
 # Version is fixed in the GitLab runner for building documentation
-sphinx==5.3.0
+sphinx==8.2.3
 sphinx-intl==2.3.1
-sphinx-rtd-theme
+sphinx-rtd-theme==3.0.2
 Jinja2==3.1.6
-markupsafe==2.1.5
+markupsafe==3.0.2
diff --git a/source/_template/layout.html b/source/_template/layout.html
@@ -86,7 +86,7 @@
 
 <div class="globalnav globalhead">
     <a class="siteNav" href="{{ pathto(master_doc) }}" >
-        <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
+        <img src="{{ pathto('_static/' + 'logo.png', 1) }}" class="logo" />
         <span class="siteNavTitle">
             Documentation
         </span>
diff --git a/source/admin/cache.rst b/source/admin/cache.rst
@@ -1,5 +1,3 @@
-.. include:: ../substitutions.rst
-
 .. _seed-cache:
 
 =================================
diff --git a/source/admin/cli.rst b/source/admin/cli.rst
@@ -1,4 +1,3 @@
-.. include:: ../substitutions.rst
 
 ======================
 Command-line interface
diff --git a/source/conf.py b/source/conf.py
@@ -212,7 +212,7 @@
 
 # Additional stuff for the LaTeX preamble.
 #'preamble': '',
-'preamble': '\setcounter{tocdepth}{2}'
+'preamble': r"\setcounter{tocdepth}{2}"
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -290,3 +290,26 @@
     r'http://mydomain.lizmap.3liz.com/',
     r'http://127.0.0.1/',
 ]
+
+# Substitutions
+rst_prolog = """
+.. |qgis_3| replace:: **QGIS 3**
+
+.. |lizmap_3_7| replace:: **Lizmap 3.7**
+
+.. |lizmap_cloud| replace:: `Lizmap Cloud <https://www.lizmap.com>`__
+
+.. |lizmap_plugin_svg| image:: /images/icons/lizmapPlugin.svg
+                       :width: 20
+                       :alt: The Lizmap logo
+.. |lizmap_cloud_svg| image:: /images/icons/logo-lizmap-cloud.png
+                      :width: 20
+                      :alt: The Lizmap Cloud logo
+.. |add_layer_svg| image:: /images/icons/symbologyAdd.svg
+.. |edit_layer_svg| image:: /images/icons/symbologyEdit.svg
+.. |remove_layer_svg| image:: /images/icons/symbologyRemove.svg
+.. |down_layer_svg| image:: /images/icons/mActionArrowDown.svg
+.. |up_layer_svg| image:: /images/icons/mActionArrowUp.svg
+.. |refresh_svg| image:: /images/icons/mActionRefresh.svg
+.. |properties_svg| image:: /images/icons/mActionPropertiesWidget.svg
+"""
diff --git a/source/lizmap_cloud/index.rst b/source/lizmap_cloud/index.rst
@@ -1,5 +1,3 @@
-.. include:: ../substitutions.rst
-
 ============
 Lizmap Cloud
 ============
diff --git a/source/publish/configuration/expression.rst b/source/publish/configuration/expression.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 QGIS Expression
 ===============
diff --git a/source/publish/configuration/legend.rst b/source/publish/configuration/legend.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Legend
 ======
diff --git a/source/publish/configuration/print.rst b/source/publish/configuration/print.rst
@@ -1,5 +1,3 @@
-.. include:: ../../substitutions.rst
-
 .. _printing:
 
 Printing
@@ -33,8 +31,7 @@ In your layout, you can add :
     - Or set :guilabel:`Fit segment width` with a correct reference anchor point to adjust the position of the scale bar
 * A location map, a map for which you have enabled and configured one *Overview*
 * Since |qgis_3|, you can use QGIS expressions, in your labels for instance. You can create automatic source label
-  according to visible layers following this example on the
-  `QGIS documentation <https://docs.qgis.org/latest/en/docs/user_manual/print_composer/composer_items/composer_label.html#id4>`_.
+  according to visible layers following `this example on the QGIS documentation <https://docs.qgis.org/latest/en/docs/user_manual/print_composer/composer_items/composer_label.html#id4>`_.
 
 .. _dynamic_content:
 
diff --git a/source/publish/configuration/project_for_web.rst b/source/publish/configuration/project_for_web.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 ==============================
 Prepare a QGIS project for Web
diff --git a/source/publish/configuration/spatial_search.rst b/source/publish/configuration/spatial_search.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 .. _fts-searches:
 
 Spatial searching
diff --git a/source/publish/layer_properties/attributes_form.rst b/source/publish/layer_properties/attributes_form.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Attributes Form
 ===============
diff --git a/source/publish/layer_properties/display.rst b/source/publish/layer_properties/display.rst
@@ -1,5 +1,3 @@
-.. include:: ../../substitutions.rst
-
 Display
 =======
 
diff --git a/source/publish/layer_properties/qgis_server.rst b/source/publish/layer_properties/qgis_server.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 .. _layer_qgis_server:
 
diff --git a/source/publish/layer_properties/rendering.rst b/source/publish/layer_properties/rendering.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Rendering
 =========
diff --git a/source/publish/lizmap_plugin/actions.rst b/source/publish/lizmap_plugin/actions.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Actions — Add some custom buttons triggering PostgreSQL queries
 ===============================================================
diff --git a/source/publish/lizmap_plugin/atlas.rst b/source/publish/lizmap_plugin/atlas.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Atlas — A sequence of entities
 ==============================
diff --git a/source/publish/lizmap_plugin/attribute_table.rst b/source/publish/lizmap_plugin/attribute_table.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 .. _attribute_table:
 
diff --git a/source/publish/lizmap_plugin/dataviz.rst b/source/publish/lizmap_plugin/dataviz.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Dataviz — Display some charts
 =============================
diff --git a/source/publish/lizmap_plugin/editing.rst b/source/publish/lizmap_plugin/editing.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 .. _editing:
 
diff --git a/source/publish/lizmap_plugin/filtered_layers_login.rst b/source/publish/lizmap_plugin/filtered_layers_login.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 .. _filtered-layer-by-user:
 
 Filtered layer by user — Set some features visible/editable or not for some users
diff --git a/source/publish/lizmap_plugin/form_filtering.rst b/source/publish/lizmap_plugin/form_filtering.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Form filtering — Filter layer data based on field values
 ========================================================
diff --git a/source/publish/lizmap_plugin/information.rst b/source/publish/lizmap_plugin/information.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Information — Get some news about the project and your server
 =============================================================
diff --git a/source/publish/lizmap_plugin/installation.rst b/source/publish/lizmap_plugin/installation.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Install and upgrade the Lizmap plugin
 =====================================
@@ -23,4 +22,4 @@ Install it with the QGIS plugin manager:
 .. image:: /images/introduction-install-lizmap.jpg
    :align: center
    :width: 60%
-   :alt: Lizmap plugin installation in the QGIS plugin manager
+   :alt: Lizmap plugin installation in the QGIS plugin manager
diff --git a/source/publish/lizmap_plugin/layers.rst b/source/publish/lizmap_plugin/layers.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Layers — Settings for each layer
 ================================
diff --git a/source/publish/lizmap_plugin/locate_by_layer.rst b/source/publish/lizmap_plugin/locate_by_layer.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 .. _locate-by-layer:
 
 Locate by layer — The locating tool
diff --git a/source/publish/lizmap_plugin/map_options.rst b/source/publish/lizmap_plugin/map_options.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 .. _lizmap-config-map:
 
diff --git a/source/publish/lizmap_plugin/time_manager.rst b/source/publish/lizmap_plugin/time_manager.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Time Manager — Animation of temporal vector layers
 ==================================================
diff --git a/source/publish/lizmap_plugin/tooltip.rst b/source/publish/lizmap_plugin/tooltip.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 Tooltip — Configure the tooltip for some layers
 ===============================================
diff --git a/source/publish/quick_start/index.rst b/source/publish/quick_start/index.rst
@@ -1,4 +1,3 @@
-.. include:: ../../substitutions.rst
 
 ..
    _The purpose of this quick start is to provide a page without too much anchor to other pages.
diff --git a/source/substitutions.rst b/source/substitutions.rst

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-.. include:: ../substitutions.rst`
`2`		`-`
`3`	`1`	`.. _seed-cache:`
`4`	`2`
`5`	`3`	`=================================`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-.. include:: ../substitutions.rst`
`2`	`1`
`3`	`2`	`======================`
`4`	`3`	`Command-line interface`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-.. include:: ../substitutions.rst`
`2`		`-`
`3`	`1`	`============`
`4`	`2`	`Lizmap Cloud`
`5`	`3`	`============`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-.. include:: ../../substitutions.rst`
`2`	`1`
`3`	`2`	`QGIS Expression`
`4`	`3`	`===============`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-.. include:: ../../substitutions.rst`
`2`	`1`
`3`	`2`	`Legend`
`4`	`3`	`======`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-.. include:: ../../substitutions.rst`
`2`	`1`
`3`	`2`	`==============================`
`4`	`3`	`Prepare a QGIS project for Web`