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

Support for Dokka in the JavaDoc integration #2117

Open
pauliesnug opened this issue May 5, 2024 · 5 comments
Open

Support for Dokka in the JavaDoc integration #2117

pauliesnug opened this issue May 5, 2024 · 5 comments
Assignees
Labels
feature New feature request plugin

Comments

@pauliesnug
Copy link
Contributor

Request details

Currently, if a .jar file ends with -javadoc.jar, it can be viewed through the Reposilite web UI. Trying to do this with a -dokka.jar, Kotlin's documentation engine doesn't seem to work. Is it possible for the JavaDoc detection to include files ending with -dokka.jar? Or would more support need to be added to support Dokka due to a different file structure?

@dzikoysk dzikoysk added feature New feature request and removed triage labels May 7, 2024
@dzikoysk dzikoysk changed the title feature: add support for Dokka in the JavaDoc integration Support for Dokka in the JavaDoc integration May 7, 2024
@dzikoysk
Copy link
Owner

dzikoysk commented May 7, 2024

I honestly don't know, as I never used Dokka 😅 But yeah, it makes sense to support it at some point.

@pauliesnug
Copy link
Contributor Author

I honestly don't know, as I never used Dokka 😅 But yeah, it makes sense to support it at some point.

I wonder if it would work if we just changed the artifact ID to end with -javadoc.jar

@RedstoneWizard08
Copy link

I honestly don't know, as I never used Dokka 😅 But yeah, it makes sense to support it at some point.

I wonder if it would work if we just changed the artifact ID to end with -javadoc.jar

Not quite. Reposilite's access control breaks some stuff and things don't render properly.

@pauliesnug
Copy link
Contributor Author

I honestly don't know, as I never used Dokka 😅 But yeah, it makes sense to support it at some point.

I wonder if it would work if we just changed the artifact ID to end with -javadoc.jar

Not quite. Reposilite's access control breaks some stuff and things don't render properly.

Oh cool! Thank you so much for the PR! I'd love Dokka support so much, our team could really use it

@TOTHT0MI
Copy link
Contributor

TOTHT0MI commented Aug 31, 2024

Dokka by default generates an HTML documentation, so it's only a static-site serving task.
However it can also output in javadoc format and Markdown. The later requires a markdown engine in the frontend, if we wish to support all formats.

See HTML format here (sorry for redaction, don't wanna plug other projects):
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature request plugin
Projects
None yet
Development

No branches or pull requests

4 participants