mkdocs.yml 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. site_name: Flameshot Developer Docs
  2. site_url: https://flameshot.org/docs/dev/
  3. repo_url: https://github.com/flameshot-org/flameshot/
  4. edit_uri: tree/master/docs/dev/src
  5. docs_dir: src
  6. site_dir: output
  7. markdown_extensions:
  8. - admonition
  9. - attr_list
  10. - toc:
  11. permalink: "#"
  12. - pymdownx.emoji:
  13. emoji_index: !!python/name:materialx.emoji.twemoji
  14. emoji_generator: !!python/name:materialx.emoji.to_svg
  15. plugins:
  16. - search
  17. - mkdoxy:
  18. projects:
  19. flameshot:
  20. src-dirs: ../../src/
  21. full-doc: True
  22. doxy-cfg:
  23. FILE_PATTERNS: "*.cpp *.h"
  24. # #TODO for some reason this causes an exception
  25. EXCLUDE_PATTERNS: "*/capturetool.h"
  26. FULL_PATH_NAMES: "NO"
  27. SHOW_USED_FILES: "NO"
  28. RECURSIVE: True
  29. save-api: mkdoxy-generated
  30. debug: True
  31. ignore-errors: False
  32. theme:
  33. name: material
  34. logo: https://flameshot.org/flameshot-icon.svg
  35. nav:
  36. - Overview: index.md
  37. - Debugging: debugging.md
  38. - FAQ: faq.md
  39. - 'Maintaining the documentation': docs.md
  40. - API:
  41. - Classes: flameshot/classes.md
  42. - 'Class Hierarchy': flameshot/hierarchy.md
  43. - Files: flameshot/files.md