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

Documentation with api: prefix always adds io.micronaut prefix #643

Open
radovanradic opened this issue Dec 19, 2023 · 0 comments
Open

Documentation with api: prefix always adds io.micronaut prefix #643

radovanradic opened this issue Dec 19, 2023 · 0 comments

Comments

@radovanradic
Copy link

radovanradic commented Dec 19, 2023

Projects generating documentation from ascii doc files and having api: links will always add io.micronaut prefix to the API links even when API does not belong to Micronaut libraries. Would be good, if possible, to configure api links and tell they don't belong to Micronaut but that current project so prefix is not added. This is done for manually added api links as well as auto generated configuration references. An example of test that shows how links are being generated:

class CommonApiMacroSpec extends AbstractConverterSpec {
    def "api module always adds io.micronaut prefix"() {
        when:
        convert "api:net.example.ServiceSettings[]"

        then:
        converted == '<div class="paragraph">\n<p><a href="../api/io/micronaut/net/example/ServiceSettings.html">ServiceSettings</a></p>\n</div>'
    }
}

this should not contain /io/micronaut/ prefix in the API link.

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

No branches or pull requests

1 participant