Skip to content
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.

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

Internal docs generation updates #16411

Merged
merged 2 commits into from
Feb 21, 2022
Merged

Internal docs generation updates #16411

merged 2 commits into from
Feb 21, 2022

Conversation

fauxpark
Copy link
Member

Description

  • Moved doxygen output directory to .build/ so make clean/qmk clean can scrub it
  • Exclude atsam stuff
  • Add defines for __DOXYGEN__ and PROGMEM - former allows excluding stuff from being documented (LUFA does this)
  • Removed -a argument from moxygen command so it doesn't generate this ugly stuff after the headings:
    image

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

lib/python/qmk/cli/generate/docs.py Outdated Show resolved Hide resolved
@zvecr zvecr merged commit f30f963 into qmk:master Feb 21, 2022
@fauxpark fauxpark deleted the doxygen-updates branch February 21, 2022 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants