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

[FX-518] Can auto-generate docs for forage-android #90

Merged

Conversation

djoksimo
Copy link
Contributor

@djoksimo djoksimo commented Sep 11, 2023

What

Demo here 👉🏻 https://64ff457005e28927ecd4924f--endearing-semolina-5b7c34.netlify.app/

# sync Gradle in Android Studio

./gradlew dokkaHtml # generate reference-docs/

cd reference-docs/ # 
open index.html # or npx http-serve to open the docs website.

Why

  • Separate inherited members in docs
    • Helps clean up the docs pages where we inherit from chunky classes like LinearLayout.
    • With the latest version of Dokka, we cannot hide these inherited members entirely, we can only separate them.

Tests Added / Updated?

No, gradle change.

Used netlify drop to deploy "temporary" hosted version of these docs to review them.

Screenshots

How

  • Can be released as-is and allow us to manually generate docs
  • Created a ticket to make the internal code internal
  • Will/can be followed by Github action change PR so we can auto deploy docs on new releases.

@djoksimo
Copy link
Contributor Author

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@djoksimo djoksimo changed the title Add auto-generated docs for forage-android [FX-518] Can auto-generate docs for forage-android Sep 11, 2023
@djoksimo djoksimo force-pushed the danilo/fx-518-use-dokka-to-build-mvp-of-android-reference-docs branch from 8261555 to 789a53d Compare September 11, 2023 16:44
@djoksimo djoksimo marked this pull request as ready for review September 11, 2023 17:10
@dleis612 dleis612 force-pushed the danilo/fx-518-use-dokka-to-build-mvp-of-android-reference-docs branch from 0b26681 to 85fea18 Compare September 28, 2023 20:55
id "org.jetbrains.dokka" version "1.9.0"
}

subprojects {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to do this subproject thing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want to generate reference docs for our sample-app and I couldn't get the docs to build without defining the dokka configuration in the root-level build.gradle

@dleis612 dleis612 force-pushed the danilo/fx-518-use-dokka-to-build-mvp-of-android-reference-docs branch from 90eb942 to d6da5fd Compare September 29, 2023 21:48
@djoksimo djoksimo added the documentation Improvements or additions to documentation label Jan 3, 2024
@djoksimo djoksimo force-pushed the danilo/fx-518-use-dokka-to-build-mvp-of-android-reference-docs branch 2 times, most recently from 358e099 to 499e3bf Compare January 3, 2024 23:39
@djoksimo djoksimo force-pushed the danilo/fx-518-use-dokka-to-build-mvp-of-android-reference-docs branch 3 times, most recently from 70766fb to bc38446 Compare January 5, 2024 20:39
@djoksimo djoksimo force-pushed the danilo/fx-518-use-dokka-to-build-mvp-of-android-reference-docs branch from bc38446 to e60a2c8 Compare January 5, 2024 20:43
@djoksimo djoksimo merged commit 3a2ed6c into main Jan 5, 2024
3 checks passed
@djoksimo djoksimo deleted the danilo/fx-518-use-dokka-to-build-mvp-of-android-reference-docs branch January 5, 2024 22:58
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
None yet
Development

Successfully merging this pull request may close these issues.

2 participants