Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for sensitivity module (refs #3876) #3877

Merged
merged 38 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
6be377e
First API doc stage
lpofredc Jan 3, 2024
5479724
Sensitivity module usage documentation
lpofredc Jan 3, 2024
19eafe3
update changelog
lpofredc Jan 3, 2024
3b118c2
fix wrong po update
lpofredc May 29, 2024
a105609
Update docs/usage/sensitivity.rst
lpofredc May 29, 2024
5f3aa84
Update docs/install/sensitivity.rst
lpofredc May 29, 2024
3496cd8
Update docs/usage/sensitivity.rst
lpofredc May 29, 2024
49fbd09
Update docs/usage/sensitivity.rst
lpofredc May 29, 2024
071ad36
Update docs/usage/sensitivity.rst
lpofredc May 29, 2024
e2bb34f
Update docs/usage/sensitivity.rst
lpofredc May 29, 2024
12f5c20
Update docs/usage/sensitivity.rst
lpofredc May 29, 2024
7c937ee
restructure sensitivity module doc
lpofredc May 30, 2024
7665c05
remove venv
lpofredc May 30, 2024
113e526
Fix doc
lpofredc May 30, 2024
24b34bb
revert doc translation
lpofredc May 30, 2024
25c8333
Update docs/install/advanced-configuration.rst
lpofredc May 30, 2024
995ef32
Update docs/install/advanced-configuration.rst
lpofredc May 30, 2024
2424416
Update docs/install/import.rst
lpofredc May 30, 2024
f775878
Update docs/usage/apis.rst
lpofredc May 30, 2024
9beb7b4
Update docs/install/import.rst
lpofredc May 30, 2024
528baf1
Update docs/install/import.rst
lpofredc May 30, 2024
08ab288
Update docs/install/import.rst
lpofredc May 30, 2024
7b63a80
Update docs/install/import.rst
lpofredc May 30, 2024
3f2a3b7
Update docs/usage/apis.rst
lpofredc May 30, 2024
3035e0f
Update docs/usage/apis.rst
lpofredc May 30, 2024
40960e0
Update docs/usage/apis.rst
lpofredc May 30, 2024
fb72e7c
Update docs/usage/apis.rst
lpofredc May 30, 2024
be4ec34
Merge branch 'master' into doc_sensitivity_module
lpofredc Jun 13, 2024
233445f
Update docs/usage/apis.rst
lpofredc Jun 13, 2024
1817a0f
Update docs/usage/apis.rst
lpofredc Jun 13, 2024
e5f32c0
Update docs/usage/apis.rst
lpofredc Jun 13, 2024
44ac6fc
Update docs/usage/apis.rst
lpofredc Jun 13, 2024
9d9b27a
Update docs/usage/apis.rst
lpofredc Jun 13, 2024
6887ba2
Update docs/usage/apis.rst
lpofredc Jun 13, 2024
9282be7
Apply suggestions from code review
lpofredc Jun 13, 2024
5f54307
Fix a typing error
lpofredc Jun 13, 2024
d9bc831
Update docs/install/import.rst
lpofredc Jun 24, 2024
262c166
Merge branch 'master' into doc_sensitivity_module
lpofredc Jun 24, 2024
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
Binary file modified docs/data-model/sensitivity.pdf
Binary file not shown.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Welcome to Geotrek's documentation!
usage/configuration-ttw.rst
usage/externals-apis.rst
usage/qgis.rst
usage/sensitivity.rst
faq.rst

.. toctree::
Expand Down
16 changes: 1 addition & 15 deletions docs/install/sensitivity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,21 +66,7 @@ or:

sudo geotrek import geotrek.sensitivity.parsers.RegulatorySensitiveAreaShapeParser <file.shp>.

Attributes for "zones sensibles espèce" are:

* espece : species name. Mandatory. A species with this name must have been previously created.
* contact : contact (text or HTML format). Optional.
* descriptio : description (text or HTML format). Optional.

Attributes for "zones sensibles réglementaires" are:

* name: zone name.
* contact : contact (text or HTML format). Optional.
* descriptio : description (text or HTML format). Optional.
* periode : month numbers of zone occupation, separated by comas, without spaces (ex. « 6,7,8 » for june, july and august)
* pratiques : sport practices names, separated by comas, without spaces (ex. « Terrestre,Aérien »). A sport practice with this name must have been previously created.
* url : card url. Optional.

You can refer to sensitivy module usage to format correctly the import files (:ref:`Import`)
lpofredc marked this conversation as resolved.
Show resolved Hide resolved

Sync to Geotrek-rando
lpofredc marked this conversation as resolved.
Show resolved Hide resolved
---------------------
Expand Down
9 changes: 7 additions & 2 deletions docs/locales/fr/LC_MESSAGES/CONTRIBUTING.po
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Geotrek 2.100\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-09-08 08:02+0000\n"
"POT-Creation-Date: 2024-01-03 16:13+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: fr\n"
Expand Down Expand Up @@ -141,7 +141,9 @@ msgid "All new lines of code are tested"
msgstr ""

#: ../../CONTRIBUTING.rst:47
msgid "There is an entry in the changelog file"
msgid ""
"There is an entry in the changelog file (with the corresponding issue "
"referenced)"
msgstr ""

#: ../../CONTRIBUTING.rst:49
Expand Down Expand Up @@ -514,3 +516,6 @@ msgid ""
"details)"
msgstr ""

#~ msgid "There is an entry in the changelog file"
#~ msgstr ""

67 changes: 38 additions & 29 deletions docs/locales/fr/LC_MESSAGES/authors.po
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Geotrek 2.38\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-09-08 08:02+0000\n"
"POT-Creation-Date: 2024-01-03 16:13+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -109,114 +109,123 @@ msgstr ""
msgid "Hugo Hasson"
msgstr ""

#: ../../authors.rst:34
#: ../../authors.rst:29
msgid "Joaquim Nallar"
msgstr ""

#: ../../authors.rst:35
msgid "Parc national des Ecrins"
msgstr ""

#: ../../authors.rst:36
#: ../../authors.rst:37
msgid "Camille Monchicourt"
msgstr ""

#: ../../authors.rst:37
#: ../../authors.rst:38
msgid "Théo Lechémia"
msgstr ""

#: ../../authors.rst:38
#: ../../authors.rst:39
msgid "Élie Bouttier"
msgstr ""

#: ../../authors.rst:41
#: ../../authors.rst:42
msgid "Others"
msgstr ""

#: ../../authors.rst:43
#: ../../authors.rst:44
msgid "Michaël Viadere (OpenIG)"
msgstr ""

#: ../../authors.rst:44
#: ../../authors.rst:45
msgid "Guillaume Boitel"
msgstr ""

#: ../../authors.rst:45
#: ../../authors.rst:46
msgid "Jean Lenormand"
msgstr ""

#: ../../authors.rst:46
#: ../../authors.rst:47
msgid "Claude Paroz"
msgstr ""

#: ../../authors.rst:47
#: ../../authors.rst:48
msgid "Amandine Sahl (Parc National des Cévennes)"
msgstr ""

#: ../../authors.rst:48
#: ../../authors.rst:49
msgid "Frédéric Cloitre (LPO AuRA)"
msgstr ""

#: ../../authors.rst:49
#: ../../authors.rst:50
msgid "Idrissa Djepa Creutz (OepnIG / Parc National des Cévennes)"
msgstr ""

#: ../../authors.rst:50
#: ../../authors.rst:51
msgid "Yannick LE DUC"
msgstr ""

#: ../../authors.rst:51
#: ../../authors.rst:52
msgid "Guillaume Boitel (Parc National de Port Cros)"
msgstr ""

#: ../../authors.rst:52
#: ../../authors.rst:53
msgid "Pierre Loicq (Parc National de la Vanoise)"
msgstr ""

#: ../../authors.rst:55
msgid "Credits"
#: ../../authors.rst:54
msgid "Nathanaël (@roipoussiere)"
msgstr ""

#: ../../authors.rst:57
msgid "Credits"
msgstr ""

#: ../../authors.rst:59
msgid "*Information desk* by Alex Berkowitz from The Noun Project"
msgstr ""

#: ../../authors.rst:58
#: ../../authors.rst:60
msgid "*Calendar* by Laurent Patain from The Noun Project"
msgstr ""

#: ../../authors.rst:59
#: ../../authors.rst:61
msgid "*Restaurant* designed by Roberto Pinto from the Noun Project"
msgstr ""

#: ../../authors.rst:60
#: ../../authors.rst:62
msgid "*Kayak* designed by johanna from the Noun Project"
msgstr ""

#: ../../authors.rst:61
#: ../../authors.rst:63
msgid "*Luggage* designed by Luis Prado from the Noun Project"
msgstr ""

#: ../../authors.rst:62
#: ../../authors.rst:64
msgid "*Location* designed by Jacob Lowe from the Noun Project"
msgstr ""

#: ../../authors.rst:63
#: ../../authors.rst:65
msgid "*Food* designed by Rémy Médard from the Noun Project"
msgstr ""

#: ../../authors.rst:64
#: ../../authors.rst:66
msgid "*Climbing* designed by Eric Milet from the Noun Project"
msgstr ""

#: ../../authors.rst:65
#: ../../authors.rst:67
msgid "*Box Office* designed by Alessio Damiano from the Noun Project"
msgstr ""

#: ../../authors.rst:66
#: ../../authors.rst:68
msgid "*Steep Descent* designed by Sergey Patutin from the Noun Project"
msgstr ""

#: ../../authors.rst:67
#: ../../authors.rst:69
msgid "*Landscape* by Adrien Coquet from the Noun Project"
msgstr ""

#: ../../authors.rst:68
#: ../../authors.rst:70
msgid "*Ski course* by Sahua D from the Noun Project"
msgstr ""

Loading