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

[Docs] Partition Doxygen Docs #12836

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[Docs] Partition Doxygen Docs #12836

wants to merge 7 commits into from

Conversation

matekelemen
Copy link
Contributor

@matekelemen matekelemen commented Nov 8, 2024

Partition Doxygen documentation into core and each application separately for faster generation.

@matekelemen matekelemen requested review from a team as code owners November 8, 2024 17:03
Copy link
Member

@loumalouomega loumalouomega left a 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

@matekelemen
Copy link
Contributor Author

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 <kratos_repo_root>/applications/<your_app>/documents/doxygen, which you're welcome to edit to your liking.

Public Applications

To quickly generate the docs and check the results, run the script at <kratos_repo_root>/documents/mkdocs.sh:

mkdocs.sh -a your_app

This generates docs for your_app (provided it is in the kratos applications' directory) as well as core.

Private Applications

If 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:

mkdocs.sh -e your_app_name,your_apps_parent_dir

@matekelemen
Copy link
Contributor Author

this PR is ready @sunethwarna

Copy link
Member

@sunethwarna sunethwarna left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants