Merge pull request #704 from sigrennesmetropole/switch_to_mkdocs

Switch to mkdocs
georchestra · Jul 3, 2023 · 5bf4d32 · 5bf4d32
2 parents 6bb039e + 81e949f
commit 5bf4d32
Show file tree

Hide file tree

Showing 179 changed files with 2,464 additions and 2,210 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,9 +2,15 @@
 database/config.sh
 
 .DS_Store
-docs/.venv/
-docs/_build/
-docs/rsync.bash
+
+# documentation MkDocs
+venv_mkdocs/
+.venv_mkdocs/
+docs_modules/
+modules/
+docs/tableofcontent.md
+
+
 cadastrapp/target/*
 addons/cadastrapp/js/build/cadastrapp.js
 database/test.sh
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,26 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# seul le HTML en ligne est supporté par MKDocs
+# formats:
+# - pdf
+
+
+# Set the version of Python and other tools you might need
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.9"
+
+mkdocs:
+ configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+ install:
+ - requirements: requirements.txt
+
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/_images/logo_craig.png b/docs/_images/logo_craig.png
diff --git a/docs/_images/logo_rennes_metropole.png b/docs/_images/logo_rennes_metropole.png
diff --git a/docs/_images/schema_cadastrapp.png b/docs/_images/schema_cadastrapp.png
diff --git a/docs/build.bash b/docs/build.bash
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/css/extra.css b/docs/css/extra.css
@@ -0,0 +1,26 @@
+
+
+:root {
+ --md-primary-fg-color:#85127e;
+ --md-primary-fg-color--light:#85127e;
+ --md-primary-fg-color--dark:#85127e;
+ --md-primary-bg-color:#fff;
+ --md-primary-bg-color--light:#ffffffb3;
+ --md-accent-fg-color:#526cfe;
+ --md-accent-fg-color--transparent:#526cfe1a;
+ --md-accent-bg-color:#fff;
+ --md-accent-bg-color--light:#ffffffb3
+}
+
+h1, h2, h3 {
+ color:rgb(133, 18, 126)!important;
+ font-weight:600!important;
+}
+
+.md-typeset {
+ font-size: .75rem;
+}
+
+footer {
+ background-color: #500b4c!important;
+}
diff --git a/docs/guide_administrateur/_images/QGIS2019_MCD_v2.0_DBeaver.png b/docs/guide_administrateur/_images/QGIS2019_MCD_v2.0_DBeaver.png
diff --git a/docs/guide_administrateur/configuration_addon.rst b/docs/guide_administrateur/configuration_addon.rst
diff --git a/docs/guide_administrateur/configuration_webapp.rst b/docs/guide_administrateur/configuration_webapp.rst
diff --git a/docs/guide_administrateur/donnees_cadastrapp.rst b/docs/guide_administrateur/donnees_cadastrapp.rst
diff --git a/docs/guide_developpeur/api.rst b/docs/guide_developpeur/api.rst