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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generate doxygen documentation #1513
Conversation
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/milestone 0.27.0 |
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
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.
I love this 馃ぉ
Really nice and clean 馃憤
PS
I have adjusted the license's badge link that should fix the README rendering issue.
Update: thanks to the CNCF (@caniszczyk) we now have |
/milestone 0.28.1 |
Up! |
Issues go stale after 90d of inactivity. Mark the issue as fresh with Stale issues rot after an additional 30d of inactivity and eventually close. If this issue is safe to close now please do so with Provide feedback via https://github.com/falcosecurity/community. /lifecycle stale |
/milestone 0.32.0 |
Hey @leodido What do you think about unblocking this PR so that we can continue this effort in subsequent PRs? Even though the current status of this PR does not achieve the final result, it seems to be working. Thus, IMO, it is worth merging it as-is now. |
Stale issues rot after 30d of inactivity. Mark the issue as fresh with Rotten issues close after an additional 30d of inactivity. If this issue is safe to close now please do so with Provide feedback via https://github.com/falcosecurity/community. /lifecycle rotten |
Rotten issues close after 30d of inactivity. Reopen the issue with Mark the issue as fresh with Provide feedback via https://github.com/falcosecurity/community. |
@poiana: Closed this PR. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
What type of PR is this?
/kind documentation
/kind feature
Any specific area of the project related to this PR?
/area build
What this PR does / why we need it:
This PR introduces a way to build the Falco development docs. 馃帀
Docs for developers, and people that want to contribute to Falco, are a long-standing feature needed by our community. Thus, I decided to package this gift for our awesome community 馃巵
Namely, this PR:
GenerateDocs
- to generate Doxygen documentationdoxygen
,jinja2
, andpygments
installed on the machineHow to try it out
Then open the
build/docs/doxygen/html/index.html
file in your browser.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Things to do to consider it 100% done:
/hold
Does this PR introduce a user-facing change?: