From 96a7cbe9549453c6e2fe57dd587fd06192c7af39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Mon, 30 Jun 2025 14:38:30 +0200 Subject: [PATCH] set up mkdocs --- .gitignore | 1 + Dockerfile | 3 + admin/.gitignore | 1 + admin/{ => docs}/cover-admin.pdf | Bin admin/{ => docs}/cover-admin.svg | 0 admin/{ => docs}/generation-documents.md | 0 .../libre-office-fonction-substituant.png | 0 .../libre-office-insert-renvoi.png | 0 admin/{ => docs}/known-limits.md | 0 admin/{ => docs}/metadata.yaml | 0 admin/{ => docs}/start.md | 0 admin/mkdocs.yml | 43 +++++++++++ build-pandoc.sh | 24 ++---- requirements.txt | 3 + user/.gitignore | 1 + user/{ => docs}/00000-toc.md | 0 user/{ => docs}/English/activity.md | 0 user/{ => docs}/English/aside_activities.md | 0 user/{ => docs}/English/bulk_reassign.md | 0 user/{ => docs}/English/documents.md | 0 user/{ => docs}/English/household.md | 0 user/{ => docs}/English/metadata.yaml | 0 user/{ => docs}/English/notifications.md | 0 user/{ => docs}/English/person.md | 0 user/{ => docs}/English/private_comments.md | 0 user/{ => docs}/English/search.md | 0 user/{ => docs}/English/social_actions.md | 0 user/{ => docs}/English/support_trajectory.md | 0 user/{ => docs}/English/tasks.md | 0 user/{ => docs}/English/thirdparty.md | 0 user/{ => docs}/English/workflow.md | 0 user/{ => docs}/_a-classer.md | 0 user/{ => docs}/activite.md | 0 user/{ => docs}/adresses.md | 0 user/{ => docs}/aside_activities.md | 0 user/{ => docs}/concept.md | 0 user/{ => docs}/cover-user.pdf | Bin user/{ => docs}/cover-user.svg | 0 user/{ => docs}/document.md | 0 user/{ => docs}/exports.md | 0 .../{ => docs}/exports_accompanying_period.md | 0 .../exports_accompanying_period_work.md | 0 ...rts_accompanying_period_work_evaluation.md | 0 user/{ => docs}/exports_activity.md | 0 user/{ => docs}/exports_aside_activity.md | 0 user/{ => docs}/exports_calendar.md | 0 user/{ => docs}/exports_household.md | 0 user/{ => docs}/exports_person.md | 0 user/{ => docs}/homepage.md | 0 user/{ => docs}/img/a_chill_page.png | 0 user/{ => docs}/img/action_accompagnement.png | 0 user/{ => docs}/img/address_details_modal.png | 0 ...ls_modal_with_address_reference_change.png | 0 .../img/address_inline_with_button.png | 0 ...address_inline_with_button_and_warning.png | 0 user/{ => docs}/img/advanced_search.png | 0 .../{ => docs}/img/aside_activity_details.png | 0 user/{ => docs}/img/banner_all.png | 0 user/{ => docs}/img/banner_course.png | 0 user/{ => docs}/img/banner_household.png | 0 user/{ => docs}/img/banner_person.png | 0 user/{ => docs}/img/chill_buttons.png | 0 user/{ => docs}/img/choisir-une-adresse.png | 0 user/{ => docs}/img/concerned_persons.png | 0 .../img/export_select_saved_exports.png | 0 ..._activity__accompanying_period_id_2705.png | 0 .../img/fr_notification_126_show.png | 0 user/{ => docs}/img/fr_notification_inbox.png | 0 .../img/fr_person_2811_document.png | 0 .../img/fr_person_2811_document_new.png | 0 .../{ => docs}/img/fr_person_2811_general.png | 0 ...r_person_2811_residential-address_list.png | 0 .../img/fr_person_2811_resources_list.png | 0 .../img/fr_person_household_376_addresses.png | 0 .../img/fr_person_household_376_summary.png | 0 user/{ => docs}/img/fr_person_new.png | 0 ...ee_vendeeperson_2811_infomedicale_view.png | 0 ...ee_vendeeperson_2811_infosociopro_view.png | 0 ...ndeepersonmineur_2821_infofamille_view.png | 0 ...vendeepersonmineur_2821_scolarite_view.png | 0 .../img/generer_document_parcours.png | 0 .../img/logo-chill-outil-accompagnement.svg | 0 user/{ => docs}/img/menage_filiations.png | 0 user/{ => docs}/img/new_aside_activity.png | 0 user/{ => docs}/img/new_task.png | 0 user/{ => docs}/img/notification_parcours.png | 0 user/{ => docs}/img/parcours_comments.png | 0 user/{ => docs}/img/parcours_confirm.png | 0 user/{ => docs}/img/parcours_dashboard.png | 0 user/{ => docs}/img/parcours_list_item.png | 0 user/{ => docs}/img/parcours_localisation.png | 0 user/{ => docs}/img/thirdparty_contact.png | 0 user/{ => docs}/img/thirdparty_morale.png | 0 user/{ => docs}/img/workflow_create.png | 0 .../img/workflow_create_with_existing.png | 0 .../img/workflow_list_associated.png | 0 user/{ => docs}/img/workflow_page.png | 0 user/{ => docs}/interface.md | 0 user/{ => docs}/intro.md | 0 user/{ => docs}/map/map.inkscape.svg | 0 user/{ => docs}/menage.md | 0 user/{ => docs}/metadata.yaml | 0 user/{ => docs}/notes_privées.md | 0 user/{ => docs}/notifications.md | 0 user/{ => docs}/nouveautes.md | 0 user/{ => docs}/parcours.md | 0 user/{ => docs}/parcours_a_trier.md | 0 user/{ => docs}/person-vendee.md | 0 user/{ => docs}/person.md | 0 user/{ => docs}/reassigner_parcours.md | 0 user/{ => docs}/search.md | 0 user/{ => docs}/social_actions.md | 0 user/{ => docs}/tasks.md | 0 user/{ => docs}/thirdparty.md | 0 user/{ => docs}/workflows.md | 0 user/mkdocs.yml | 69 ++++++++++++++++++ 116 files changed, 128 insertions(+), 17 deletions(-) create mode 100644 Dockerfile create mode 100644 admin/.gitignore rename admin/{ => docs}/cover-admin.pdf (100%) rename admin/{ => docs}/cover-admin.svg (100%) rename admin/{ => docs}/generation-documents.md (100%) rename admin/{ => docs}/img/generation-document/libre-office-fonction-substituant.png (100%) rename admin/{ => docs}/img/generation-document/libre-office-insert-renvoi.png (100%) rename admin/{ => docs}/known-limits.md (100%) rename admin/{ => docs}/metadata.yaml (100%) rename admin/{ => docs}/start.md (100%) create mode 100644 admin/mkdocs.yml create mode 100644 requirements.txt create mode 100644 user/.gitignore rename user/{ => docs}/00000-toc.md (100%) rename user/{ => docs}/English/activity.md (100%) rename user/{ => docs}/English/aside_activities.md (100%) rename user/{ => docs}/English/bulk_reassign.md (100%) rename user/{ => docs}/English/documents.md (100%) rename user/{ => docs}/English/household.md (100%) rename user/{ => docs}/English/metadata.yaml (100%) rename user/{ => docs}/English/notifications.md (100%) rename user/{ => docs}/English/person.md (100%) rename user/{ => docs}/English/private_comments.md (100%) rename user/{ => docs}/English/search.md (100%) rename user/{ => docs}/English/social_actions.md (100%) rename user/{ => docs}/English/support_trajectory.md (100%) rename user/{ => docs}/English/tasks.md (100%) rename user/{ => docs}/English/thirdparty.md (100%) rename user/{ => docs}/English/workflow.md (100%) rename user/{ => docs}/_a-classer.md (100%) rename user/{ => docs}/activite.md (100%) rename user/{ => docs}/adresses.md (100%) rename user/{ => docs}/aside_activities.md (100%) rename user/{ => docs}/concept.md (100%) rename user/{ => docs}/cover-user.pdf (100%) rename user/{ => docs}/cover-user.svg (100%) rename user/{ => docs}/document.md (100%) rename user/{ => docs}/exports.md (100%) rename user/{ => docs}/exports_accompanying_period.md (100%) rename user/{ => docs}/exports_accompanying_period_work.md (100%) rename user/{ => docs}/exports_accompanying_period_work_evaluation.md (100%) rename user/{ => docs}/exports_activity.md (100%) rename user/{ => docs}/exports_aside_activity.md (100%) rename user/{ => docs}/exports_calendar.md (100%) rename user/{ => docs}/exports_household.md (100%) rename user/{ => docs}/exports_person.md (100%) rename user/{ => docs}/homepage.md (100%) rename user/{ => docs}/img/a_chill_page.png (100%) rename user/{ => docs}/img/action_accompagnement.png (100%) rename user/{ => docs}/img/address_details_modal.png (100%) rename user/{ => docs}/img/address_details_modal_with_address_reference_change.png (100%) rename user/{ => docs}/img/address_inline_with_button.png (100%) rename user/{ => docs}/img/address_inline_with_button_and_warning.png (100%) rename user/{ => docs}/img/advanced_search.png (100%) rename user/{ => docs}/img/aside_activity_details.png (100%) rename user/{ => docs}/img/banner_all.png (100%) rename user/{ => docs}/img/banner_course.png (100%) rename user/{ => docs}/img/banner_household.png (100%) rename user/{ => docs}/img/banner_person.png (100%) rename user/{ => docs}/img/chill_buttons.png (100%) rename user/{ => docs}/img/choisir-une-adresse.png (100%) rename user/{ => docs}/img/concerned_persons.png (100%) rename user/{ => docs}/img/export_select_saved_exports.png (100%) rename user/{ => docs}/img/fr_activity__accompanying_period_id_2705.png (100%) rename user/{ => docs}/img/fr_notification_126_show.png (100%) rename user/{ => docs}/img/fr_notification_inbox.png (100%) rename user/{ => docs}/img/fr_person_2811_document.png (100%) rename user/{ => docs}/img/fr_person_2811_document_new.png (100%) rename user/{ => docs}/img/fr_person_2811_general.png (100%) rename user/{ => docs}/img/fr_person_2811_residential-address_list.png (100%) rename user/{ => docs}/img/fr_person_2811_resources_list.png (100%) rename user/{ => docs}/img/fr_person_household_376_addresses.png (100%) rename user/{ => docs}/img/fr_person_household_376_summary.png (100%) rename user/{ => docs}/img/fr_person_new.png (100%) rename user/{ => docs}/img/fr_vendee_vendeeperson_2811_infomedicale_view.png (100%) rename user/{ => docs}/img/fr_vendee_vendeeperson_2811_infosociopro_view.png (100%) rename user/{ => docs}/img/fr_vendee_vendeepersonmineur_2821_infofamille_view.png (100%) rename user/{ => docs}/img/fr_vendee_vendeepersonmineur_2821_scolarite_view.png (100%) rename user/{ => docs}/img/generer_document_parcours.png (100%) rename user/{ => docs}/img/logo-chill-outil-accompagnement.svg (100%) rename user/{ => docs}/img/menage_filiations.png (100%) rename user/{ => docs}/img/new_aside_activity.png (100%) rename user/{ => docs}/img/new_task.png (100%) rename user/{ => docs}/img/notification_parcours.png (100%) rename user/{ => docs}/img/parcours_comments.png (100%) rename user/{ => docs}/img/parcours_confirm.png (100%) rename user/{ => docs}/img/parcours_dashboard.png (100%) rename user/{ => docs}/img/parcours_list_item.png (100%) rename user/{ => docs}/img/parcours_localisation.png (100%) rename user/{ => docs}/img/thirdparty_contact.png (100%) rename user/{ => docs}/img/thirdparty_morale.png (100%) rename user/{ => docs}/img/workflow_create.png (100%) rename user/{ => docs}/img/workflow_create_with_existing.png (100%) rename user/{ => docs}/img/workflow_list_associated.png (100%) rename user/{ => docs}/img/workflow_page.png (100%) rename user/{ => docs}/interface.md (100%) rename user/{ => docs}/intro.md (100%) rename user/{ => docs}/map/map.inkscape.svg (100%) rename user/{ => docs}/menage.md (100%) rename user/{ => docs}/metadata.yaml (100%) rename user/{ => docs}/notes_privées.md (100%) rename user/{ => docs}/notifications.md (100%) rename user/{ => docs}/nouveautes.md (100%) rename user/{ => docs}/parcours.md (100%) rename user/{ => docs}/parcours_a_trier.md (100%) rename user/{ => docs}/person-vendee.md (100%) rename user/{ => docs}/person.md (100%) rename user/{ => docs}/reassigner_parcours.md (100%) rename user/{ => docs}/search.md (100%) rename user/{ => docs}/social_actions.md (100%) rename user/{ => docs}/tasks.md (100%) rename user/{ => docs}/thirdparty.md (100%) rename user/{ => docs}/workflows.md (100%) create mode 100644 user/mkdocs.yml diff --git a/.gitignore b/.gitignore index 51b6bae..71f2b76 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ build/* *-manual.pdf +.venv/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..572467b --- /dev/null +++ b/Dockerfile @@ -0,0 +1,3 @@ +FROM nginx:alpine +LABEL authors="Julien Fastré" + diff --git a/admin/.gitignore b/admin/.gitignore new file mode 100644 index 0000000..a5b3032 --- /dev/null +++ b/admin/.gitignore @@ -0,0 +1 @@ +site/* \ No newline at end of file diff --git a/admin/cover-admin.pdf b/admin/docs/cover-admin.pdf similarity index 100% rename from admin/cover-admin.pdf rename to admin/docs/cover-admin.pdf diff --git a/admin/cover-admin.svg b/admin/docs/cover-admin.svg similarity index 100% rename from admin/cover-admin.svg rename to admin/docs/cover-admin.svg diff --git a/admin/generation-documents.md b/admin/docs/generation-documents.md similarity index 100% rename from admin/generation-documents.md rename to admin/docs/generation-documents.md diff --git a/admin/img/generation-document/libre-office-fonction-substituant.png b/admin/docs/img/generation-document/libre-office-fonction-substituant.png similarity index 100% rename from admin/img/generation-document/libre-office-fonction-substituant.png rename to admin/docs/img/generation-document/libre-office-fonction-substituant.png diff --git a/admin/img/generation-document/libre-office-insert-renvoi.png b/admin/docs/img/generation-document/libre-office-insert-renvoi.png similarity index 100% rename from admin/img/generation-document/libre-office-insert-renvoi.png rename to admin/docs/img/generation-document/libre-office-insert-renvoi.png diff --git a/admin/known-limits.md b/admin/docs/known-limits.md similarity index 100% rename from admin/known-limits.md rename to admin/docs/known-limits.md diff --git a/admin/metadata.yaml b/admin/docs/metadata.yaml similarity index 100% rename from admin/metadata.yaml rename to admin/docs/metadata.yaml diff --git a/admin/start.md b/admin/docs/start.md similarity index 100% rename from admin/start.md rename to admin/docs/start.md diff --git a/admin/mkdocs.yml b/admin/mkdocs.yml new file mode 100644 index 0000000..daa1e96 --- /dev/null +++ b/admin/mkdocs.yml @@ -0,0 +1,43 @@ +--- +site_name: "Manuel admnistrateur Chill" +site_url: https://manuel.chill.social/administrateur/ +repo_url: https://gitea.champs-libres.be/Chill-project/manuals +repo_name: Chill-project/manuals +theme: + name: material + features: + - content.code.copy + - content.code.select + - content.code.annotate +nav: + - Accueil: index.md + - Génération de document: generation-documents.md +markdown_extensions: + - markdown_include.include + # code layout + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + use_pygments: true + linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + # admonition + - admonition + - pymdownx.details + - pymdownx.superfences + # use emojis + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + # footnotes + - footnotes + # https://squidfunk.github.io/mkdocs-material/reference/formatting/?h=key#adding-keyboard-keys + - pymdownx.critic + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde \ No newline at end of file diff --git a/build-pandoc.sh b/build-pandoc.sh index 49bfcc5..189babc 100755 --- a/build-pandoc.sh +++ b/build-pandoc.sh @@ -4,7 +4,8 @@ set -e # enter the current directory cd "$(dirname $0)" -export PANDOC_DIR="/pandoc/cl" +export PANDOC_DIR="$(pwd)/pandoc/cl" +export OUTPUT_DIR="$(pwd)" if [ -z $1 ]; then @@ -59,7 +60,9 @@ else exit 1; fi -cd $kind +export PDF_TEMPLATE="$(pwd)/eisvogel.latex" + +cd $kind/docs export ARGS=" --from markdown @@ -67,14 +70,12 @@ export ARGS=" --resource-path ./. --metadata-file ./metadata.yaml " -export PDF_TEMPLATE="./../eisvogel.latex" export LATEX_ARGS=" --metadata=footer-left:$(date +%d-%m-%Y) --template ${PDF_TEMPLATE} - --lua-filter "..${PANDOC_DIR}/boxes.lua" + --lua-filter "${PANDOC_DIR}/boxes.lua" " - if [ $target = "latex" ]; then pandoc $ARGS $LATEX_ARGS \ --to latex \ @@ -83,18 +84,7 @@ elif [ $target = "pdf" ]; then pandoc $ARGS $LATEX_ARGS \ --to pdf \ --pdf-engine xelatex \ - -o "./../$kind-manual.pdf" \ + -o "${OUTPUT_DIR}/$kind-manual.pdf" \ $files -elif [ $target = "html" ]; then - # check target directory exists - if [ ! -d "./../build/html" ]; then - echo "create build/html directory" - mkdir -p "./../build/html" - fi - - pandoc $ARGS \ - --to html \ - -o ./../build/html/index.html \ - $files fi diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8801a72 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +mkdocs +markdown-include +mkdocs-material \ No newline at end of file diff --git a/user/.gitignore b/user/.gitignore new file mode 100644 index 0000000..913aeb2 --- /dev/null +++ b/user/.gitignore @@ -0,0 +1 @@ +site/* diff --git a/user/00000-toc.md b/user/docs/00000-toc.md similarity index 100% rename from user/00000-toc.md rename to user/docs/00000-toc.md diff --git a/user/English/activity.md b/user/docs/English/activity.md similarity index 100% rename from user/English/activity.md rename to user/docs/English/activity.md diff --git a/user/English/aside_activities.md b/user/docs/English/aside_activities.md similarity index 100% rename from user/English/aside_activities.md rename to user/docs/English/aside_activities.md diff --git a/user/English/bulk_reassign.md b/user/docs/English/bulk_reassign.md similarity index 100% rename from user/English/bulk_reassign.md rename to user/docs/English/bulk_reassign.md diff --git a/user/English/documents.md b/user/docs/English/documents.md similarity index 100% rename from user/English/documents.md rename to user/docs/English/documents.md diff --git a/user/English/household.md b/user/docs/English/household.md similarity index 100% rename from user/English/household.md rename to user/docs/English/household.md diff --git a/user/English/metadata.yaml b/user/docs/English/metadata.yaml similarity index 100% rename from user/English/metadata.yaml rename to user/docs/English/metadata.yaml diff --git a/user/English/notifications.md b/user/docs/English/notifications.md similarity index 100% rename from user/English/notifications.md rename to user/docs/English/notifications.md diff --git a/user/English/person.md b/user/docs/English/person.md similarity index 100% rename from user/English/person.md rename to user/docs/English/person.md diff --git a/user/English/private_comments.md b/user/docs/English/private_comments.md similarity index 100% rename from user/English/private_comments.md rename to user/docs/English/private_comments.md diff --git a/user/English/search.md b/user/docs/English/search.md similarity index 100% rename from user/English/search.md rename to user/docs/English/search.md diff --git a/user/English/social_actions.md b/user/docs/English/social_actions.md similarity index 100% rename from user/English/social_actions.md rename to user/docs/English/social_actions.md diff --git a/user/English/support_trajectory.md b/user/docs/English/support_trajectory.md similarity index 100% rename from user/English/support_trajectory.md rename to user/docs/English/support_trajectory.md diff --git a/user/English/tasks.md b/user/docs/English/tasks.md similarity index 100% rename from user/English/tasks.md rename to user/docs/English/tasks.md diff --git a/user/English/thirdparty.md b/user/docs/English/thirdparty.md similarity index 100% rename from user/English/thirdparty.md rename to user/docs/English/thirdparty.md diff --git a/user/English/workflow.md b/user/docs/English/workflow.md similarity index 100% rename from user/English/workflow.md rename to user/docs/English/workflow.md diff --git a/user/_a-classer.md b/user/docs/_a-classer.md similarity index 100% rename from user/_a-classer.md rename to user/docs/_a-classer.md diff --git a/user/activite.md b/user/docs/activite.md similarity index 100% rename from user/activite.md rename to user/docs/activite.md diff --git a/user/adresses.md b/user/docs/adresses.md similarity index 100% rename from user/adresses.md rename to user/docs/adresses.md diff --git a/user/aside_activities.md b/user/docs/aside_activities.md similarity index 100% rename from user/aside_activities.md rename to user/docs/aside_activities.md diff --git a/user/concept.md b/user/docs/concept.md similarity index 100% rename from user/concept.md rename to user/docs/concept.md diff --git a/user/cover-user.pdf b/user/docs/cover-user.pdf similarity index 100% rename from user/cover-user.pdf rename to user/docs/cover-user.pdf diff --git a/user/cover-user.svg b/user/docs/cover-user.svg similarity index 100% rename from user/cover-user.svg rename to user/docs/cover-user.svg diff --git a/user/document.md b/user/docs/document.md similarity index 100% rename from user/document.md rename to user/docs/document.md diff --git a/user/exports.md b/user/docs/exports.md similarity index 100% rename from user/exports.md rename to user/docs/exports.md diff --git a/user/exports_accompanying_period.md b/user/docs/exports_accompanying_period.md similarity index 100% rename from user/exports_accompanying_period.md rename to user/docs/exports_accompanying_period.md diff --git a/user/exports_accompanying_period_work.md b/user/docs/exports_accompanying_period_work.md similarity index 100% rename from user/exports_accompanying_period_work.md rename to user/docs/exports_accompanying_period_work.md diff --git a/user/exports_accompanying_period_work_evaluation.md b/user/docs/exports_accompanying_period_work_evaluation.md similarity index 100% rename from user/exports_accompanying_period_work_evaluation.md rename to user/docs/exports_accompanying_period_work_evaluation.md diff --git a/user/exports_activity.md b/user/docs/exports_activity.md similarity index 100% rename from user/exports_activity.md rename to user/docs/exports_activity.md diff --git a/user/exports_aside_activity.md b/user/docs/exports_aside_activity.md similarity index 100% rename from user/exports_aside_activity.md rename to user/docs/exports_aside_activity.md diff --git a/user/exports_calendar.md b/user/docs/exports_calendar.md similarity index 100% rename from user/exports_calendar.md rename to user/docs/exports_calendar.md diff --git a/user/exports_household.md b/user/docs/exports_household.md similarity index 100% rename from user/exports_household.md rename to user/docs/exports_household.md diff --git a/user/exports_person.md b/user/docs/exports_person.md similarity index 100% rename from user/exports_person.md rename to user/docs/exports_person.md diff --git a/user/homepage.md b/user/docs/homepage.md similarity index 100% rename from user/homepage.md rename to user/docs/homepage.md diff --git a/user/img/a_chill_page.png b/user/docs/img/a_chill_page.png similarity index 100% rename from user/img/a_chill_page.png rename to user/docs/img/a_chill_page.png diff --git a/user/img/action_accompagnement.png b/user/docs/img/action_accompagnement.png similarity index 100% rename from user/img/action_accompagnement.png rename to user/docs/img/action_accompagnement.png diff --git a/user/img/address_details_modal.png b/user/docs/img/address_details_modal.png similarity index 100% rename from user/img/address_details_modal.png rename to user/docs/img/address_details_modal.png diff --git a/user/img/address_details_modal_with_address_reference_change.png b/user/docs/img/address_details_modal_with_address_reference_change.png similarity index 100% rename from user/img/address_details_modal_with_address_reference_change.png rename to user/docs/img/address_details_modal_with_address_reference_change.png diff --git a/user/img/address_inline_with_button.png b/user/docs/img/address_inline_with_button.png similarity index 100% rename from user/img/address_inline_with_button.png rename to user/docs/img/address_inline_with_button.png diff --git a/user/img/address_inline_with_button_and_warning.png b/user/docs/img/address_inline_with_button_and_warning.png similarity index 100% rename from user/img/address_inline_with_button_and_warning.png rename to user/docs/img/address_inline_with_button_and_warning.png diff --git a/user/img/advanced_search.png b/user/docs/img/advanced_search.png similarity index 100% rename from user/img/advanced_search.png rename to user/docs/img/advanced_search.png diff --git a/user/img/aside_activity_details.png b/user/docs/img/aside_activity_details.png similarity index 100% rename from user/img/aside_activity_details.png rename to user/docs/img/aside_activity_details.png diff --git a/user/img/banner_all.png b/user/docs/img/banner_all.png similarity index 100% rename from user/img/banner_all.png rename to user/docs/img/banner_all.png diff --git a/user/img/banner_course.png b/user/docs/img/banner_course.png similarity index 100% rename from user/img/banner_course.png rename to user/docs/img/banner_course.png diff --git a/user/img/banner_household.png b/user/docs/img/banner_household.png similarity index 100% rename from user/img/banner_household.png rename to user/docs/img/banner_household.png diff --git a/user/img/banner_person.png b/user/docs/img/banner_person.png similarity index 100% rename from user/img/banner_person.png rename to user/docs/img/banner_person.png diff --git a/user/img/chill_buttons.png b/user/docs/img/chill_buttons.png similarity index 100% rename from user/img/chill_buttons.png rename to user/docs/img/chill_buttons.png diff --git a/user/img/choisir-une-adresse.png b/user/docs/img/choisir-une-adresse.png similarity index 100% rename from user/img/choisir-une-adresse.png rename to user/docs/img/choisir-une-adresse.png diff --git a/user/img/concerned_persons.png b/user/docs/img/concerned_persons.png similarity index 100% rename from user/img/concerned_persons.png rename to user/docs/img/concerned_persons.png diff --git a/user/img/export_select_saved_exports.png b/user/docs/img/export_select_saved_exports.png similarity index 100% rename from user/img/export_select_saved_exports.png rename to user/docs/img/export_select_saved_exports.png diff --git a/user/img/fr_activity__accompanying_period_id_2705.png b/user/docs/img/fr_activity__accompanying_period_id_2705.png similarity index 100% rename from user/img/fr_activity__accompanying_period_id_2705.png rename to user/docs/img/fr_activity__accompanying_period_id_2705.png diff --git a/user/img/fr_notification_126_show.png b/user/docs/img/fr_notification_126_show.png similarity index 100% rename from user/img/fr_notification_126_show.png rename to user/docs/img/fr_notification_126_show.png diff --git a/user/img/fr_notification_inbox.png b/user/docs/img/fr_notification_inbox.png similarity index 100% rename from user/img/fr_notification_inbox.png rename to user/docs/img/fr_notification_inbox.png diff --git a/user/img/fr_person_2811_document.png b/user/docs/img/fr_person_2811_document.png similarity index 100% rename from user/img/fr_person_2811_document.png rename to user/docs/img/fr_person_2811_document.png diff --git a/user/img/fr_person_2811_document_new.png b/user/docs/img/fr_person_2811_document_new.png similarity index 100% rename from user/img/fr_person_2811_document_new.png rename to user/docs/img/fr_person_2811_document_new.png diff --git a/user/img/fr_person_2811_general.png b/user/docs/img/fr_person_2811_general.png similarity index 100% rename from user/img/fr_person_2811_general.png rename to user/docs/img/fr_person_2811_general.png diff --git a/user/img/fr_person_2811_residential-address_list.png b/user/docs/img/fr_person_2811_residential-address_list.png similarity index 100% rename from user/img/fr_person_2811_residential-address_list.png rename to user/docs/img/fr_person_2811_residential-address_list.png diff --git a/user/img/fr_person_2811_resources_list.png b/user/docs/img/fr_person_2811_resources_list.png similarity index 100% rename from user/img/fr_person_2811_resources_list.png rename to user/docs/img/fr_person_2811_resources_list.png diff --git a/user/img/fr_person_household_376_addresses.png b/user/docs/img/fr_person_household_376_addresses.png similarity index 100% rename from user/img/fr_person_household_376_addresses.png rename to user/docs/img/fr_person_household_376_addresses.png diff --git a/user/img/fr_person_household_376_summary.png b/user/docs/img/fr_person_household_376_summary.png similarity index 100% rename from user/img/fr_person_household_376_summary.png rename to user/docs/img/fr_person_household_376_summary.png diff --git a/user/img/fr_person_new.png b/user/docs/img/fr_person_new.png similarity index 100% rename from user/img/fr_person_new.png rename to user/docs/img/fr_person_new.png diff --git a/user/img/fr_vendee_vendeeperson_2811_infomedicale_view.png b/user/docs/img/fr_vendee_vendeeperson_2811_infomedicale_view.png similarity index 100% rename from user/img/fr_vendee_vendeeperson_2811_infomedicale_view.png rename to user/docs/img/fr_vendee_vendeeperson_2811_infomedicale_view.png diff --git a/user/img/fr_vendee_vendeeperson_2811_infosociopro_view.png b/user/docs/img/fr_vendee_vendeeperson_2811_infosociopro_view.png similarity index 100% rename from user/img/fr_vendee_vendeeperson_2811_infosociopro_view.png rename to user/docs/img/fr_vendee_vendeeperson_2811_infosociopro_view.png diff --git a/user/img/fr_vendee_vendeepersonmineur_2821_infofamille_view.png b/user/docs/img/fr_vendee_vendeepersonmineur_2821_infofamille_view.png similarity index 100% rename from user/img/fr_vendee_vendeepersonmineur_2821_infofamille_view.png rename to user/docs/img/fr_vendee_vendeepersonmineur_2821_infofamille_view.png diff --git a/user/img/fr_vendee_vendeepersonmineur_2821_scolarite_view.png b/user/docs/img/fr_vendee_vendeepersonmineur_2821_scolarite_view.png similarity index 100% rename from user/img/fr_vendee_vendeepersonmineur_2821_scolarite_view.png rename to user/docs/img/fr_vendee_vendeepersonmineur_2821_scolarite_view.png diff --git a/user/img/generer_document_parcours.png b/user/docs/img/generer_document_parcours.png similarity index 100% rename from user/img/generer_document_parcours.png rename to user/docs/img/generer_document_parcours.png diff --git a/user/img/logo-chill-outil-accompagnement.svg b/user/docs/img/logo-chill-outil-accompagnement.svg similarity index 100% rename from user/img/logo-chill-outil-accompagnement.svg rename to user/docs/img/logo-chill-outil-accompagnement.svg diff --git a/user/img/menage_filiations.png b/user/docs/img/menage_filiations.png similarity index 100% rename from user/img/menage_filiations.png rename to user/docs/img/menage_filiations.png diff --git a/user/img/new_aside_activity.png b/user/docs/img/new_aside_activity.png similarity index 100% rename from user/img/new_aside_activity.png rename to user/docs/img/new_aside_activity.png diff --git a/user/img/new_task.png b/user/docs/img/new_task.png similarity index 100% rename from user/img/new_task.png rename to user/docs/img/new_task.png diff --git a/user/img/notification_parcours.png b/user/docs/img/notification_parcours.png similarity index 100% rename from user/img/notification_parcours.png rename to user/docs/img/notification_parcours.png diff --git a/user/img/parcours_comments.png b/user/docs/img/parcours_comments.png similarity index 100% rename from user/img/parcours_comments.png rename to user/docs/img/parcours_comments.png diff --git a/user/img/parcours_confirm.png b/user/docs/img/parcours_confirm.png similarity index 100% rename from user/img/parcours_confirm.png rename to user/docs/img/parcours_confirm.png diff --git a/user/img/parcours_dashboard.png b/user/docs/img/parcours_dashboard.png similarity index 100% rename from user/img/parcours_dashboard.png rename to user/docs/img/parcours_dashboard.png diff --git a/user/img/parcours_list_item.png b/user/docs/img/parcours_list_item.png similarity index 100% rename from user/img/parcours_list_item.png rename to user/docs/img/parcours_list_item.png diff --git a/user/img/parcours_localisation.png b/user/docs/img/parcours_localisation.png similarity index 100% rename from user/img/parcours_localisation.png rename to user/docs/img/parcours_localisation.png diff --git a/user/img/thirdparty_contact.png b/user/docs/img/thirdparty_contact.png similarity index 100% rename from user/img/thirdparty_contact.png rename to user/docs/img/thirdparty_contact.png diff --git a/user/img/thirdparty_morale.png b/user/docs/img/thirdparty_morale.png similarity index 100% rename from user/img/thirdparty_morale.png rename to user/docs/img/thirdparty_morale.png diff --git a/user/img/workflow_create.png b/user/docs/img/workflow_create.png similarity index 100% rename from user/img/workflow_create.png rename to user/docs/img/workflow_create.png diff --git a/user/img/workflow_create_with_existing.png b/user/docs/img/workflow_create_with_existing.png similarity index 100% rename from user/img/workflow_create_with_existing.png rename to user/docs/img/workflow_create_with_existing.png diff --git a/user/img/workflow_list_associated.png b/user/docs/img/workflow_list_associated.png similarity index 100% rename from user/img/workflow_list_associated.png rename to user/docs/img/workflow_list_associated.png diff --git a/user/img/workflow_page.png b/user/docs/img/workflow_page.png similarity index 100% rename from user/img/workflow_page.png rename to user/docs/img/workflow_page.png diff --git a/user/interface.md b/user/docs/interface.md similarity index 100% rename from user/interface.md rename to user/docs/interface.md diff --git a/user/intro.md b/user/docs/intro.md similarity index 100% rename from user/intro.md rename to user/docs/intro.md diff --git a/user/map/map.inkscape.svg b/user/docs/map/map.inkscape.svg similarity index 100% rename from user/map/map.inkscape.svg rename to user/docs/map/map.inkscape.svg diff --git a/user/menage.md b/user/docs/menage.md similarity index 100% rename from user/menage.md rename to user/docs/menage.md diff --git a/user/metadata.yaml b/user/docs/metadata.yaml similarity index 100% rename from user/metadata.yaml rename to user/docs/metadata.yaml diff --git a/user/notes_privées.md b/user/docs/notes_privées.md similarity index 100% rename from user/notes_privées.md rename to user/docs/notes_privées.md diff --git a/user/notifications.md b/user/docs/notifications.md similarity index 100% rename from user/notifications.md rename to user/docs/notifications.md diff --git a/user/nouveautes.md b/user/docs/nouveautes.md similarity index 100% rename from user/nouveautes.md rename to user/docs/nouveautes.md diff --git a/user/parcours.md b/user/docs/parcours.md similarity index 100% rename from user/parcours.md rename to user/docs/parcours.md diff --git a/user/parcours_a_trier.md b/user/docs/parcours_a_trier.md similarity index 100% rename from user/parcours_a_trier.md rename to user/docs/parcours_a_trier.md diff --git a/user/person-vendee.md b/user/docs/person-vendee.md similarity index 100% rename from user/person-vendee.md rename to user/docs/person-vendee.md diff --git a/user/person.md b/user/docs/person.md similarity index 100% rename from user/person.md rename to user/docs/person.md diff --git a/user/reassigner_parcours.md b/user/docs/reassigner_parcours.md similarity index 100% rename from user/reassigner_parcours.md rename to user/docs/reassigner_parcours.md diff --git a/user/search.md b/user/docs/search.md similarity index 100% rename from user/search.md rename to user/docs/search.md diff --git a/user/social_actions.md b/user/docs/social_actions.md similarity index 100% rename from user/social_actions.md rename to user/docs/social_actions.md diff --git a/user/tasks.md b/user/docs/tasks.md similarity index 100% rename from user/tasks.md rename to user/docs/tasks.md diff --git a/user/thirdparty.md b/user/docs/thirdparty.md similarity index 100% rename from user/thirdparty.md rename to user/docs/thirdparty.md diff --git a/user/workflows.md b/user/docs/workflows.md similarity index 100% rename from user/workflows.md rename to user/docs/workflows.md diff --git a/user/mkdocs.yml b/user/mkdocs.yml new file mode 100644 index 0000000..ad16803 --- /dev/null +++ b/user/mkdocs.yml @@ -0,0 +1,69 @@ +--- +site_name: "Manuel du logiciel Chill" +site_url: https://manuel.chill.social/user/ +repo_url: https://gitea.champs-libres.be/Chill-project/manuals +repo_name: Chill-project/manuals +theme: + name: material + features: + - content.code.copy + - content.code.select + - content.code.annotate +nav: + - Accueil: index.md + - Génération de document: generation-documents.md + + - Introduction: intro.md + - Concepts: concept.md + - Interface: interface.md + - Recherche: search.md + - Dossier d'usager: person.md + - Échanges: activite.md + - Documents: document.md + - Tiers: thirdparty.md + - Ménages: menage.md + - Parcours: + - Généralités sur les parcours: parcours.md + - Actions d'accompagnement: social_actions.md + - Réassigner les parcours: reassigner_parcours.md + - Notifications: notifications.md + - Tâches: tasks.md + - Workflow / suivi de décisions: workflows.md + - Adresses: adresses.md + - Notes privées: notes_privées.md + - Exports: + - Généralités: exports.md + - Exports liés aux usagers: exports_person.md + - Exports liés aux échanges: exports_activity.md + - Exports liés aux parcours: exports_accompanying_period.md + - Exports liés aux actions sociales: exports_accompanying_period_work.md + - Exports liés aux évaluations: exports_accompanying_period_work_evaluation.md +markdown_extensions: + - markdown_include.include + # code layout + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + use_pygments: true + linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + # admonition + - admonition + - pymdownx.details + - pymdownx.superfences + # use emojis + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + # footnotes + - footnotes + # https://squidfunk.github.io/mkdocs-material/reference/formatting/?h=key#adding-keyboard-keys + - pymdownx.critic + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde \ No newline at end of file