Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,37 +13,43 @@ before_script:

# Build without translations, for MR
build_html_mr:
image: ${REGISTRY_URL}/factory-ci-runner:build-doc
only:
- merge_requests
- manual
stage: build_html
script:
- pip list
- make clean html SPHINXBUILD=sphinx-build SPHINXINTL=sphinx-intl
artifacts:
paths:
- build/html/
name: "lizmapdoc-$CI_COMMIT_REF_NAME"
tags:
- infrav2
- factory-plain


# Build with translations, for main branches
build_html_i18n:
image: ${REGISTRY_URL}/factory-ci-runner:build-doc
only:
- master
- lizmap_3_9
- lizmap_3_8
stage: build_html
script:
- pip list
- ./update_from_transifex.sh -f
- make clean html SPHINXBUILD=sphinx-build SPHINXINTL=sphinx-intl
artifacts:
paths:
- build/html/
name: "lizmapdoc-$CI_COMMIT_REF_NAME"
tags:
- infrav2
- factory-plain

push_transifex:
image: ${REGISTRY_URL}/factory-ci-runner:build-doc
only:
- master
- lizmap_3_9
Expand All @@ -53,9 +59,10 @@ push_transifex:
- make gettext SPHINXBUILD=sphinx-build SPHINXINTL=sphinx-intl
- tx -H $TX_API -t $TX_TOKEN push -s
tags:
- infrav2
- factory-plain

deploy_snap:
image: ${REGISTRY_URL}/factory-ci-runner:build-doc
only:
- master
- lizmap_3_9
Expand All @@ -69,9 +76,10 @@ deploy_snap:
environment:
name: snap
tags:
- infrav2
- factory-plain

deploy_production:
image: ${REGISTRY_URL}/factory-ci-runner:build-doc
only:
- master
- lizmap_3_9
Expand All @@ -86,4 +94,4 @@ deploy_production:
name: production
when: manual
tags:
- infrav2
- factory-plain
23 changes: 23 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " html[lang] to make standalone HTML files for specific language"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
Expand All @@ -40,11 +41,26 @@ help:
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " lang display available languages"

requirements:
uv export --format requirements.txt \
--no-annotate \
--no-editable \
--no-hashes \
-q -o requirements.txt

clean:
-rm -rf $(BUILDDIR)/*
-rm -rf i18n/*/LC_MESSAGES/*.mo

lang:
@echo "Available languages:"
@for lang in $(LANGUAGES);\
do \
echo "* $$lang"; \
done

html:
$(SPHINXINTL) build -d i18n
@for lang in $(LANGUAGES);\
Expand All @@ -59,6 +75,13 @@ htmlen:
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/."

html%:
$(SPHINXINTL) build -d i18n
mkdir -p $(BUILDDIR)/html/$* $(BUILDDIR)/doctrees/$*; \
echo "$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) -D language=$* $(BUILDDIR)/html/$*";\
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) -D language=$* $(BUILDDIR)/html/$*;\


dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
Expand Down
2 changes: 1 addition & 1 deletion i18n/fr/LC_MESSAGES/publish.po
Original file line number Diff line number Diff line change
Expand Up @@ -2169,7 +2169,7 @@ msgid ""
"In :menuselection:`Lizmap plugin --> Layers`, you can enable for each layer "
"or group the cache (client and server side) for generated images."
msgstr ""
"Dans :menuselection:``Lizmap plugin --> Couches`, vous pouvez activer pour "
"Dans :menuselection:`Lizmap plugin --> Couches`, vous pouvez activer pour "
"chaque couche ou groupe le cache (côté client et serveur) pour les images "
"générées."

Expand Down
8 changes: 8 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

[dependency-groups]
dev = [
"sphinx",
"sphinx-intl",
"sphinx-rtd-theme",
"Jinja2",
]
35 changes: 29 additions & 6 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
# Version is fixed in the GitLab runner for building documentation
sphinx==5.3.0
sphinx-intl==2.3.1
sphinx-rtd-theme
Jinja2==3.1.6
markupsafe==2.1.5
# This file was autogenerated by uv via the following command:
# uv export --format requirements.txt --no-annotate --no-editable --no-hashes -o requirements.txt
alabaster==1.0.0
babel==2.18.0
certifi==2026.1.4
charset-normalizer==3.4.4
click==8.3.1
colorama==0.4.6 ; sys_platform == 'win32'
docutils==0.22.4
idna==3.11
imagesize==1.4.1
jinja2==3.1.6
markupsafe==3.0.3
packaging==26.0
pygments==2.19.2
requests==2.32.5
roman-numerals==4.1.0
snowballstemmer==3.0.1
sphinx==9.1.0
sphinx-intl==2.3.2
sphinx-rtd-theme==3.1.0
sphinxcontrib-applehelp==2.0.0
sphinxcontrib-devhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==2.0.0
sphinxcontrib-serializinghtml==2.0.0
urllib3==2.6.3
2 changes: 1 addition & 1 deletion source/_template/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 0 additions & 2 deletions source/admin/cache.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. include:: ../substitutions.rst

.. _seed-cache:

=================================
Expand Down
1 change: 0 additions & 1 deletion source/admin/cli.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../substitutions.rst

======================
Command-line interface
Expand Down
25 changes: 24 additions & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
"""
2 changes: 0 additions & 2 deletions source/lizmap_cloud/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. include:: ../substitutions.rst

============
Lizmap Cloud
============
Expand Down
1 change: 0 additions & 1 deletion source/publish/configuration/expression.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

QGIS Expression
===============
Expand Down
1 change: 0 additions & 1 deletion source/publish/configuration/legend.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Legend
======
Expand Down
5 changes: 1 addition & 4 deletions source/publish/configuration/print.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. include:: ../../substitutions.rst

.. _printing:

Printing
Expand Down Expand Up @@ -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:

Expand Down
1 change: 0 additions & 1 deletion source/publish/configuration/project_for_web.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

==============================
Prepare a QGIS project for Web
Expand Down
1 change: 0 additions & 1 deletion source/publish/configuration/spatial_search.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst
.. _fts-searches:

Spatial searching
Expand Down
1 change: 0 additions & 1 deletion source/publish/layer_properties/attributes_form.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Attributes Form
===============
Expand Down
2 changes: 0 additions & 2 deletions source/publish/layer_properties/display.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. include:: ../../substitutions.rst

Display
=======

Expand Down
1 change: 0 additions & 1 deletion source/publish/layer_properties/qgis_server.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

.. _layer_qgis_server:

Expand Down
1 change: 0 additions & 1 deletion source/publish/layer_properties/rendering.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Rendering
=========
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/actions.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Actions — Add some custom buttons triggering PostgreSQL queries
===============================================================
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/atlas.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Atlas — A sequence of entities
==============================
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/attribute_table.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

.. _attribute_table:

Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/dataviz.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Dataviz — Display some charts
=============================
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/editing.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

.. _editing:

Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/filtered_layers_login.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/form_filtering.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Form filtering — Filter layer data based on field values
========================================================
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/information.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Information — Get some news about the project and your server
=============================================================
Expand Down
3 changes: 1 addition & 2 deletions source/publish/lizmap_plugin/installation.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Install and upgrade the Lizmap plugin
=====================================
Expand All @@ -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
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/layers.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Layers — Settings for each layer
================================
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/locate_by_layer.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst
.. _locate-by-layer:

Locate by layer — The locating tool
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/map_options.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

.. _lizmap-config-map:

Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/time_manager.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Time Manager — Animation of temporal vector layers
==================================================
Expand Down
1 change: 0 additions & 1 deletion source/publish/lizmap_plugin/tooltip.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. include:: ../../substitutions.rst

Tooltip — Configure the tooltip for some layers
===============================================
Expand Down
1 change: 0 additions & 1 deletion source/publish/quick_start/index.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading