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

Update to Dokka 2.0.0-Beta #767

Merged
merged 3 commits into from
Oct 29, 2024
Merged

Update to Dokka 2.0.0-Beta #767

merged 3 commits into from
Oct 29, 2024

Conversation

MGaetan89
Copy link
Member

Pull request

Description

This PR updates to Dokka 2.0.0, and configures it to eventually be able to publish it.

Changes made

  • Update Dokka to 2.0.0-Beta.
  • Add a project description on the homepage of the documentation.
  • Replace the default All modules page name on the homepage with Pillarbox.
  • Hide the platform filter in the navigation bar (currently not working, I've opened an issue for that).
  • Enable Gradle's Configuration Cache.
  • Add a Module.md file to each module to describe it (it's currently a copy/pates of the first paragraph of the existing Readme.md file of each module).
  • Configure the source link of each module, so the documentation can link to the source code (currently broken for Android projects 😢).

How-to

To generate the documentation, simply run:

./gradlew :dokkaGenerate

In the output, you should see a link to access the generated documentation:

Generated Dokka HTML publication: http://localhost:63342/Pillarbox/build/dokka/html/index.html

Checklist

  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).

Copy link

github-actions bot commented Oct 25, 2024

Code Coverage

Overall Project 47.79% -0.44% 🟢
Files changed 10.07% 🟢

Module Coverage
Kover Gradle Plugin XML report for :plugins 7.54% -9.54% 🟢
Files
Module File Coverage
Kover Gradle Plugin XML report for :plugins VersionConfig.kt 100% 🟢
PillarboxAndroidLibraryPublishingPlugin.kt 0% -29.26% 🟢

@MGaetan89 MGaetan89 added this pull request to the merge queue Oct 29, 2024
Merged via the queue into main with commit 559d4c1 Oct 29, 2024
9 checks passed
@MGaetan89 MGaetan89 deleted the update_dokka branch October 29, 2024 14:52
@MGaetan89 MGaetan89 linked an issue Oct 29, 2024 that may be closed by this pull request
@MGaetan89 MGaetan89 added the documentation Improvements or additions to documentation label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Provide a consolidated documentation for Pillarbox
2 participants