Change setup to use mkdocs with mkdocs-material instead of Sphinx

2025-11-19 02:17:45 +00:00 · 2025-11-17 16:05:35 +01:00
parent 2139b53fb0
commit c647648e84
4 changed files with 158 additions and 27 deletions
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -0,0 +1,137 @@
+site_name: Chill Documentation
+site_description: Documentation for Chill - A free software for social workers
+site_url: https://docs.chill.social
+repo_url: https://gitlab.com/Chill-project/chill-bundles
+repo_name: Chill-project/chill-bundles
+
+docs_dir: source
+
+copyright: Copyright &copy; 2014-2024 Champs-Libres Cooperative SCRLFS - GNU Free Documentation License v1.3
+
+theme:
+  name: material
+  language: en
+  features:
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.expand
+    - navigation.path
+    - navigation.top
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+    - content.code.copy
+    - content.code.annotate
+
+  palette:
+    # Palette toggle for light mode
+    - scheme: default
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+plugins:
+  - search
+  - autorefs
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - toc:
+      permalink: true
+  - tables
+  - attr_list
+  - md_in_html
+
+nav:
+  - Home: index.md
+  - Installation:
+    - installation/index.md
+    - Development: installation/installation-development.md
+    - Production: installation/installation-production.md
+    - Document Storage: installation/document-storage.md
+    - Load Addresses: installation/load-addresses.md
+    - Production Setup: installation/prod.md
+    - Calendar SMS: installation/prod-calendar-sms-sending.md
+    - MS Graph Configuration: installation/msgraph-configure.md
+    - Enable Collabora: installation/enable-collabora-for-dev.md
+  - Development:
+    - development/index.md
+    - Access Control: development/access_control_model.md
+    - API: development/api.md
+    - Assets: development/assets.md
+    - Code Quality: development/code-quality.md
+    - Create Bundle: development/create-a-new-bundle.md
+    - Cronjobs: development/cronjob.md
+    - CRUD: development/crud.md
+    - Database Principles: development/database-principles.md
+    - Embeddable Comments: development/embeddable-comments.md
+    - Entity Info: development/entity-info.md
+    - ESLint: development/es-lint.md
+    - Exports: development/exports.md
+    - FAQ: development/FAQ.md
+    - Forms: development/forms.md
+    - Localisation: development/localisation.md
+    - Logging: development/logging.md
+    - Manual:
+      - development/manual/index.md
+      - Routing and Menus: development/manual/routing-and-menus.md
+    - Menus: development/menus.md
+    - Messages to Users: development/messages-to-users.md
+    - Migrations: development/migrations.md
+    - Pagination: development/pagination.md
+    - Render Entity: development/render-entity.md
+    - Routing: development/routing.md
+    - Run Tests: development/run-tests.md
+    - Searching: development/searching.md
+    - Timelines: development/timelines.md
+    - Useful Snippets: development/useful-snippets.md
+    - User Interface:
+      - CSS Classes: development/user-interface/css-classes.md
+      - JS Functions: development/user-interface/js-functions.md
+      - Layout Template: development/user-interface/layout-template-usage.md
+      - Widgets: development/user-interface/widgets.md
+  - Bundles:
+    - bundles/index.md
+    - Activity: bundles/activity.md
+    - Custom Fields: bundles/custom-fields.md
+    - Event: bundles/event.md
+    - Group: bundles/group.md
+    - LDAP: bundles/ldap.md
+    - Main: bundles/main.md
+    - Person: bundles/person.md
+    - Report: bundles/report.md
+
+extra:
+  social:
+    - icon: fontawesome/brands/gitlab
+      link: https://gitlab.com/Chill-project
+    - icon: fontawesome/solid/comments
+      link: https://app.element.io/#/room/#chill-social-admin:matrix.org