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.

Sign up for GitHub

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

Jump to bottom

Add API Reference #20

Closed
1 task done
roxk opened this issue Sep 28, 2020 · 6 comments
Closed
1 task done

Add API Reference #20

roxk opened this issue Sep 28, 2020 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@roxk
Copy link
Contributor

roxk commented Sep 28, 2020 •
edited
Loading

  • Push to gh-pages once
  • Setup github action for CD (TBC)
@roxk roxk added the documentation Improvements or additions to documentation label Sep 28, 2020
roxk added a commit that referenced this issue Sep 30, 2020
@roxk
Added dokka generator #20
bc0f5e5
@roxk
Copy link
Contributor Author

roxk commented Oct 6, 2020

Current main already contains the necessary dokka setup needed to generate API reference.

To generate an HTML artifact, run ./gradlew dokkaHtml at /. The generated artifact is located at sdk/build/dokka/html.

@roxk
Copy link
Contributor Author

roxk commented Oct 7, 2020

Deployed at

@roxk roxk closed this as completed Oct 7, 2020
@roxk
Copy link
Contributor Author

roxk commented Oct 7, 2020

sdk's nav panel is showing sdk-okhttp, re-open to fix.

@roxk roxk reopened this Oct 7, 2020
@roxk
Copy link
Contributor Author

roxk commented Oct 7, 2020 •
edited
Loading

dokka now comes with dokkaHtmlMultimodule according to this thread, would test out if it works.

Update: No such gradle task exists :/ Would see if 1.4.10 is earlier than 1.4.0-rc (which doesn't make sense to me...).

@roxk
Copy link
Contributor Author

roxk commented Oct 7, 2020

Even using 1.4.0-rc, dokkaHtmlMultimodule task just wouldn't show up💀 Still investigating...

@roxk
Copy link
Contributor Author

roxk commented Oct 7, 2020

Fixed. The problem was the the root project gradle needs to apply dokka plugin as well (Not sure why gradlew dokkaHtml works since only subproject has the plugin applied, perhaps gradle is smart enough to look into subproject's tasks....).

@roxk roxk closed this as completed Oct 7, 2020
roxk added a commit that referenced this issue Oct 8, 2020
@roxk
Fixed sdk-okhttp doc is not generated. Fixed root project not using d…
b0b8de8 
…okka #20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@roxk