Skip to content

Exclude private members from documentation and update docs README #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Poofjunior merged 2 commits into from
Jun 28, 2025
Merged

Exclude private members from documentation and update docs README #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a30c93b
Add continuous deployment criteria to docs README
glopesdev Jun 16, 2025
338719e
Remove private members from public documentation
glopesdev Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).