mkdocs.yml 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. site_name: Django CQRS Library
  2. site_url: https://github.com/cloudblue/django-cqrs
  3. repo_name: cloudblue/django-cqrs
  4. repo_url: https://github.com/cloudblue/django-cqrs
  5. edit_uri: ""
  6. copyright: Copyright © 2023 Ingram Micro. All Rights Reserved.
  7. extra:
  8. generator: false
  9. social:
  10. - icon: fontawesome/brands/github
  11. link: https://github.com/cloudblue
  12. - icon: material/home
  13. link: https://connect.cloudblue.com/community/
  14. extra_css:
  15. - css/custom.css
  16. theme:
  17. name: material
  18. logo: images/logo_full.png
  19. favicon: images/favicon.ico
  20. palette:
  21. - scheme: "default"
  22. media: "(prefers-color-scheme: light)"
  23. toggle:
  24. icon: "material/lightbulb"
  25. name: "Switch to dark mode"
  26. - scheme: "slate"
  27. media: "(prefers-color-scheme: dark)"
  28. primary: "blue"
  29. toggle:
  30. icon: "material/lightbulb-outline"
  31. name: "Switch to light mode"
  32. markdown_extensions:
  33. - admonition
  34. - pymdownx.highlight
  35. - pymdownx.superfences
  36. - pymdownx.keys
  37. - pymdownx.tabbed:
  38. alternate_style: true
  39. - pymdownx.emoji:
  40. emoji_index: !!python/name:materialx.emoji.twemoji
  41. emoji_generator: !!python/name:materialx.emoji.to_svg
  42. - attr_list
  43. - tables
  44. plugins:
  45. - glightbox
  46. - macros:
  47. module_name: docs/macros
  48. - search:
  49. lang: en
  50. - mkdocstrings:
  51. default_handler: python
  52. handlers:
  53. python:
  54. options:
  55. show_signature_annotations: true
  56. show_source: false
  57. show_bases: false
  58. show_root_toc_entry: false
  59. - autorefs
  60. watch:
  61. - docs
  62. - dj_cqrs
  63. nav:
  64. - Home: index.md
  65. - Getting started: getting_started.md
  66. - Django admin: admin.md
  67. - Custom serialization: custom_serialization.md
  68. - Keep track of changes to field: track_fields_changes.md
  69. - Transports: transports.md
  70. - Message lifecycle: lifecycle.md
  71. - Utilities: utilities.md
  72. - API Reference: reference.md