-
Notifications
You must be signed in to change notification settings - Fork 246
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
[Docs] Partition Doxygen Docs #12836
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay from my side
To every application maintainer: Each application now has its own self-contained doxygen generation and can customize its appearance. You'll find your doxygen configuration file at Public ApplicationsTo quickly generate the docs and check the results, run the script at
This generates docs for Private ApplicationsIf your app is private or otherwise outside the kratos app directory, you can still use the same script, but you'll need to provide the path to the containing directory of your application:
|
this PR is ready @sunethwarna |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice addition @matekelemen. But i think you forgot to put some checks for the dependent modules such as graphviz. Otherwise, there won't be any error message, and the user have to comb through a long log file.
Partition Doxygen documentation into core and each application separately for faster generation.