Move to mkdocs and move images

hitobito · Mar 8, 2024 · 2a4f3b6 · 2a4f3b6
1 parent 1679f1f
commit 2a4f3b6
Show file tree

Hide file tree

Showing 29 changed files with 85 additions and 5 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -15,9 +15,9 @@ python:
   install:
     - requirements: requirements.txt
 
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: ./conf.py
+# Build documentation in the docs/ directory with mkdocs
+mkdocs:
+  configuration: ./mkdocs.yml
 
 formats:
   - htmlzip

diff --git a/...ts_mailchimp_export/mailchimp_api_key.png → ...ts_mailchimp_export/mailchimp_api_key.png b/...ts_mailchimp_export/mailchimp_api_key.png → ...ts_mailchimp_export/mailchimp_api_key.png
diff --git a/...ts_mailchimp_export/mailchimp_list_id.png → ...ts_mailchimp_export/mailchimp_list_id.png b/...ts_mailchimp_export/mailchimp_list_id.png → ...ts_mailchimp_export/mailchimp_list_id.png
diff --git a/..._mailchimp_export/mailing_list_export.png → ..._mailchimp_export/mailing_list_export.png b/..._mailchimp_export/mailing_list_export.png → ..._mailchimp_export/mailing_list_export.png
diff --git a/...ailchimp_export/mailing_list_settings.png → ...ailchimp_export/mailing_list_settings.png b/...ailchimp_export/mailing_list_settings.png → ...ailchimp_export/mailing_list_settings.png
diff --git a/images/AboAdd.png b/images/AboAdd.png
diff --git a/images/AboTag.png b/images/AboTag.png
diff --git a/images/Base.png b/images/Base.png
diff --git a/images/FilterLayer.png b/images/FilterLayer.png
diff --git a/images/FilterNew.png b/images/FilterNew.png
diff --git a/images/FilterRole.png b/images/FilterRole.png
diff --git a/images/FilterSave.png b/images/FilterSave.png
diff --git a/images/GroupAdd.png b/images/GroupAdd.png
diff --git a/images/GroupDescription.png b/images/GroupDescription.png
diff --git a/images/LowLayerFull.png b/images/LowLayerFull.png
diff --git a/images/LowLayerGroup.png b/images/LowLayerGroup.png
diff --git a/images/LowLayerNone.png b/images/LowLayerNone.png
diff --git a/images/MidlayerFull.png b/images/MidlayerFull.png
diff --git a/images/MidlayerGroup.png b/images/MidlayerGroup.png
diff --git a/images/Tags.png b/images/Tags.png
diff --git a/images/TopLayerFull.png b/images/TopLayerFull.png
diff --git a/images/TopLayerFullRestrained.png b/images/TopLayerFullRestrained.png
diff --git a/images/TopLayerSubgroup.png b/images/TopLayerSubgroup.png
diff --git a/images/approvals_tab.png b/images/approvals_tab.png
diff --git a/images/invitation_list.png b/images/invitation_list.png
diff --git a/images/invitation_reply.png b/images/invitation_reply.png
diff --git a/images/pending_role_approval.png b/images/pending_role_approval.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,16 @@
+site_name: Hitobito
+theme:
+  name: readthedocs
+  highlightjs: true
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        # See: https://mkdocstrings.github.io/python/usage/
+        python:
+          options:
+            docstring_style: sphinx
+markdown_extensions:
+  - markdown_include.include:
+      base_path: .
+  - admonition
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,66 @@
-sphinx==7.1.2
-sphinx-rtd-theme==1.3.0rc1
+#
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
+#
+#    pip-compile docs/requirements.in
+#
+click==8.1.3
+    # via mkdocs
+ghp-import==2.1.0
+    # via mkdocs
+griffe==0.22.0
+    # via mkdocstrings-python
+importlib-metadata==4.12.0
+    # via mkdocs
+jinja2==3.1.2
+    # via
+    #   mkdocs
+    #   mkdocstrings
+markdown==3.3.7
+    # via
+    #   markdown-include
+    #   mkdocs
+    #   mkdocs-autorefs
+    #   mkdocstrings
+    #   pymdown-extensions
+markdown-include==0.6.0
+    # via -r docs/requirements.in
+markupsafe==2.1.1
+    # via
+    #   jinja2
+    #   mkdocstrings
+mergedeep==1.3.4
+    # via mkdocs
+mkdocs==1.3.0
+    # via
+    #   -r docs/requirements.in
+    #   mkdocs-autorefs
+    #   mkdocstrings
+mkdocs-autorefs==0.4.1
+    # via mkdocstrings
+mkdocstrings[python]==0.19.0
+    # via
+    #   -r docs/requirements.in
+    #   mkdocstrings-python
+mkdocstrings-python==0.7.1
+    # via mkdocstrings
+packaging==21.3
+    # via mkdocs
+pymdown-extensions==9.5
+    # via mkdocstrings
+pyparsing==3.0.9
+    # via packaging
+python-dateutil==2.8.2
+    # via ghp-import
+pyyaml==6.0
+    # via
+    #   mkdocs
+    #   pyyaml-env-tag
+pyyaml-env-tag==0.1
+    # via mkdocs
+six==1.16.0
+    # via python-dateutil
+watchdog==2.1.9
+    # via mkdocs
+zipp==3.8.0
+    # via importlib-metadata