We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Describe the bug
We're using Dokka 0.10.0 and outputFormat = 'jekyll' and the code is properly formatted with the use of the corresponding delimiters.
outputFormat = 'jekyll'
For instance:
# Monoid `interface Monoid<A> : `[`Semigroup`](../-semigroup/index.html)`<A>`
However, dokkaJelyll task from Dokka 1.4.32 extracts code without delimiters.
dokkaJelyll
For instance, the corresponding text for the same example as before:
# Monoid [common] interface [Monoid](index.md)<[A](index.md)> : [Semigroup](../-semigroup/index.md)<[A](index.md)>
Expected behaviour
We'd expect the same behavior as before with Dokka 0.10.0:
to get code properly rendered.
To Reproduce
Repository: https://github.com/arrow-kt/arrow
Steps:
To Reproduce: Step 1 - Generate the documentation with Dokka 0.10.0
cd arrow-libs ./gradlew dokka
To Reproduce: Step 2 - Generate the documentation with Dokka 1.4.32
dokka
arrow-libs/gradle/apidoc-creation.gradle
arrow-libs/gradle.properties
-DOKKA_VERSION=0.10.0 +DOKKA_VERSION=1.4.32
dokkaJekyll
cd arrow-libs ./gradlew dokkaJekyll
To Reproduce: Step 3 - Compare both results
For instance, compare:
./arrow-site/docs/apidocs/arrow-core/arrow.typeclasses/-monoid/index.md --- Dokka 0.10.0 ./arrow-libs/core/arrow-core/build/dokka/jekyll/arrow-core/arrow.typeclasses/-monoid/index.md --- Dokka 1.4.32
Dokka configuration
Using the default options at the beginning.
Installation
Additional context
We're trying to move from Dokka 0.10.0 to Dokka 1.4.32
0.10.0
1.4.32
Are you willing to provide a PR?
I'm willing to contribute if some guideline is provided. I just found the way to fix this thing #1968 so far.
The text was updated successfully, but these errors were encountered:
Including .md files to show how the source code doesn't have the format delimiters with Dokka 1.4.32 (task dokkaJekyll):
.md
Sorry, something went wrong.
No branches or pull requests
Describe the bug
We're using Dokka 0.10.0 and
outputFormat = 'jekyll'
and the code is properly formatted with the use of the corresponding delimiters.For instance:
However,
dokkaJelyll
task from Dokka 1.4.32 extracts code without delimiters.For instance, the corresponding text for the same example as before:
Expected behaviour
We'd expect the same behavior as before with Dokka 0.10.0:
to get code properly rendered.
To Reproduce
Repository: https://github.com/arrow-kt/arrow
Steps:
To Reproduce: Step 1 - Generate the documentation with Dokka 0.10.0
To Reproduce: Step 2 - Generate the documentation with Dokka 1.4.32
dokka
configuration inarrow-libs/gradle/apidoc-creation.gradle
arrow-libs/gradle.properties
:dokkaJekyll
:To Reproduce: Step 3 - Compare both results
For instance, compare:
Dokka configuration
Using the default options at the beginning.
Installation
Additional context
We're trying to move from Dokka
0.10.0
to Dokka1.4.32
Are you willing to provide a PR?
I'm willing to contribute if some guideline is provided. I just found the way to fix this thing #1968 so far.
The text was updated successfully, but these errors were encountered: