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

Add automated API docs generation and deployment workflow #38

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

kpavlov
Copy link
Owner

@kpavlov kpavlov commented Dec 2, 2024

This commit introduces a new Makefile target, apidocs, which organizes the generation of API documentation using Dokka. Additionally, a GitHub Actions workflow is added to automatically build and publish the documentation to GitHub Pages upon a release or manual trigger. These changes streamline the documentation process, ensuring up-to-date docs are easily accessible.

This commit introduces a new Makefile target, `apidocs`, which organizes the generation of API documentation using Dokka. Additionally, a GitHub Actions workflow is added to automatically build and publish the documentation to GitHub Pages upon a release or manual trigger. These changes streamline the documentation process, ensuring up-to-date docs are easily accessible.
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (b4c1935) 127 89 70.08%
Head commit (7bad6d5) 127 (+0) 89 (+0) 70.08% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#38) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

@kpavlov kpavlov marked this pull request as ready for review December 2, 2024 05:37
@kpavlov kpavlov merged commit 56f834a into main Dec 2, 2024
5 checks passed
@kpavlov kpavlov deleted the dokka-pages branch December 2, 2024 05:37
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.

1 participant