mirror of
https://github.com/fergalmoran/flameshot.git
synced 2025-12-29 21:30:52 +00:00
a2f036be9b
* Create developer docs * Remove mike dependency * Update docs * Make docs/dev self-contained * Add incomplete deploy-dev-docs workflow * Fix typo * Add workflow file to path: * Add doxygen as dependency * Add remaining deploy steps * Add working-directory * Fix working-directory error * Add missing Makefile * Change flameshot website repo url * Change working-directory for safety step * Add git credentials * Change push credentials * Use different token secret * Remove checkpoints * Add separate branch developer-docs * Add || true * Update docs * Update the 'Maintaining the documentation' docs * Fix error in deploy-dev-docs workflow * Remove accidentally committed file DOC.md * Update PAT expiry date * Rename developer-docs branch to dev-docs-staging
48 lines
1.2 KiB
YAML
48 lines
1.2 KiB
YAML
site_name: Flameshot Developer Docs
|
|
site_url: https://flameshot.org/docs/dev/
|
|
repo_url: https://github.com/flameshot-org/flameshot/
|
|
edit_uri: tree/master/docs/dev/src
|
|
docs_dir: src
|
|
site_dir: output
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- toc:
|
|
permalink: "#"
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
|
|
plugins:
|
|
- search
|
|
- mkdoxy:
|
|
projects:
|
|
flameshot:
|
|
src-dirs: ../../src/
|
|
full-doc: True
|
|
doxy-cfg:
|
|
FILE_PATTERNS: "*.cpp *.h"
|
|
# #TODO for some reason this causes an exception
|
|
EXCLUDE_PATTERNS: "*/capturetool.h"
|
|
FULL_PATH_NAMES: "NO"
|
|
SHOW_USED_FILES: "NO"
|
|
RECURSIVE: True
|
|
|
|
save-api: mkdoxy-generated
|
|
debug: True
|
|
ignore-errors: False
|
|
|
|
theme:
|
|
name: material
|
|
logo: https://flameshot.org/flameshot-icon.svg
|
|
|
|
nav:
|
|
- Overview: index.md
|
|
- Debugging: debugging.md
|
|
- FAQ: faq.md
|
|
- 'Maintaining the documentation': docs.md
|
|
- API:
|
|
- Classes: flameshot/classes.md
|
|
- 'Class Hierarchy': flameshot/hierarchy.md
|
|
- Files: flameshot/files.md
|