diff --git a/docs/Doxyfile b/docs/Doxyfile index 3643670..2689448 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -5,11 +5,10 @@ PROJECT_ICON = favicon.ico OUTPUT_DIRECTORY = doc_out STRIP_FROM_PATH = ../ EXTRACT_ALL = YES -EXTRACT_PRIVATE = YES -EXTRACT_PRIV_VIRTUAL = YES EXTRACT_STATIC = YES CASE_SENSE_NAMES = YES -INPUT = ../README.md ../firmware +INPUT = ../README.md \ + ../firmware RECURSIVE = YES USE_MDFILE_AS_MAINPAGE = README.md HTML_HEADER = template/custom_header.html diff --git a/docs/README.md b/docs/README.md index a658289..d770aa6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,3 +5,11 @@ To build the documentation, invoke: ```` doxygen ```` + +## Deployment + +Documentation will automatically publish to GitHub Pages when: + +* A release is made. +* A manual workflow dispatch is initiated and publishing is enabled. +* Any push to any branch is made when `CONTINUOUS_DOCUMENTATION` is enabled (intended for use in forks for development purposes). \ No newline at end of file