diff --git a/requirements.txt b/requirements.txt index 1c62a759..b657df89 100644 --- 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 \ No newline at end of file +markupsafe==3.0.2 diff --git a/source/_template/layout.html b/source/_template/layout.html index 5a7331d0..a1711dbf 100644 --- a/source/_template/layout.html +++ b/source/_template/layout.html @@ -86,7 +86,7 @@
- + Documentation diff --git a/source/admin/cache.rst b/source/admin/cache.rst index f2192693..2e5174ba 100644 --- 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 index 7ba20421..4d5de5a9 100644 --- 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 index b9cd4d4e..74142585 100644 --- 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 `__ + +.. |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/install/py-qgis-server.rst b/source/install/py-qgis-server.rst index a6a97503..ce0c6443 100644 --- a/source/install/py-qgis-server.rst +++ b/source/install/py-qgis-server.rst @@ -7,7 +7,7 @@ Py-QGIS-Server Pre-requirements ================ -We supposed, you already have installed QGIS Server packages, as explain in the +We suppose that you already have installed QGIS Server packages, as explained in the `QGIS Server documentation `_. .. note:: @@ -41,12 +41,12 @@ Folders used below .. code-block:: bash - mkdir -p /srv/qgis/plugins /srv/qgis/config /var/log/qgis /var/lib/py-qgis-server /var/data + mkdir -p /srv/qgis/plugins /srv/qgis/config /srv/data /var/log/qgis /var/lib/py-qgis-server The file to watch for restarting workers ---------------------------------------- -We create an empty file that will be watch by Py-QGIS-Server to check when to restart QGIS Server map workers. +We create an empty file that will be watched by Py-QGIS-Server to check when to restart QGIS Server map workers. .. code-block:: bash @@ -66,7 +66,7 @@ We create the executable file :file:`/usr/bin/qgis-reload` to restart QGIS Serve touch /var/lib/py-qgis-server/py-qgis-restartmon -Then we when change its mod : +Then we change its mod : .. code-block:: bash @@ -115,7 +115,7 @@ We create the Py-QGIS-Server configuration file :file:`/srv/qgis/server.conf`. I In this example: * QGIS Server will be available at ``http://127.0.0.1:7200/ows/`` -* the plugins are installed in :file`/srv/qgis/plugins` (``pluginpath``). See :ref:`qgis-server-plugins`. +* the plugins are installed in :file:`/srv/qgis/plugins` (``pluginpath``). See :ref:`qgis-server-plugins`. * the file to watch for restarting workers is :file:`/var/lib/py-qgis-server/py-qgis-restartmon` (``restartmon``). * the directory containing the projects to be published :file:`/srv/data` (``rootdir``). The projects must be in sub-folders. * Lizmap QGIS Server API is enabled @@ -141,7 +141,7 @@ First of all, we create an environment file :file:`/srv/qgis/config/qgis-service In this file, we defined: -* The lang +* The language * The Xvfb display port, needed to print PDF * The QGIS options and ``authDB`` path (needed for HTTPS, when used in remote layers such as OSM tiles) * Lizmap environment variable to reveal settings @@ -181,7 +181,7 @@ Then we can create the QGIS `service systemd file `_. + according to visible layers following `this example on the QGIS documentation `_. .. _dynamic_content: diff --git a/source/publish/configuration/project_for_web.rst b/source/publish/configuration/project_for_web.rst index 3e39d44d..e88f4cc3 100644 --- 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 index e9a6ceaa..2dce48c0 100644 --- 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 index b1342589..9f009a2d 100644 --- 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 index e5d792ee..e06b0db8 100644 --- 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 index 26c8a4e4..98b76280 100644 --- 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 index ec054cac..ee63bd78 100644 --- 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 index fc7d1f03..d41356f5 100644 --- 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 index 0ef51ad0..202bc9ef 100644 --- 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 index 285fe708..fdd0f782 100644 --- 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 index 84ac31cb..6b6d065a 100644 --- 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 index b9591c22..5e28deea 100644 --- 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 index 4104dc26..df8e5559 100644 --- 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 index bec19e23..f3e25948 100644 --- 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 index 014804e4..66dfa837 100644 --- 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 index 2b61b258..72939ff2 100644 --- 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 \ No newline at end of file + :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 index 9a575d09..4b52de1c 100644 --- 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 index a625ccc3..aedca305 100644 --- 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 index d0539206..a366e708 100644 --- 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 index b4b54ac4..0fc64f69 100644 --- 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 index 97d7ed6c..7c0929b5 100644 --- 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 index 03dc55fb..8d77a720 100644 --- 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 deleted file mode 100644 index 12983ebc..00000000 --- a/source/substitutions.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. |qgis_3| replace:: **QGIS 3** - -.. |lizmap_3_7| replace:: **Lizmap 3.7** - -.. |lizmap_cloud| replace:: `Lizmap Cloud `__ - -.. |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