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

fix: enable intra-repo links in API ref docs #716

Merged
merged 8 commits into from
Oct 6, 2022
Merged

fix: enable intra-repo links in API ref docs #716

merged 8 commits into from
Oct 6, 2022

Conversation

ianbotsf
Copy link
Contributor

@ianbotsf ianbotsf commented Oct 4, 2022 •
edited
Loading

Issue #

#715

Description of changes

  • Temporarily works around dokka#2679 by enabling non-hierarchical project compatibility mode
  • Updates external documentation links to use correct publishing location
  • Configures flatter submodule directory tree in generated documentation

Companion PRs: aws-crt-kotlin#59 & smithy-kotlin#711

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@ianbotsf ianbotsf requested a review from a team as a code owner October 4, 2022 22:28
This was referenced Oct 4, 2022
Merged
Merged
@github-actions
Copy link

github-actions bot commented Oct 4, 2022

A new generated diff is ready to view: __generated-main...__generated-fix-api-ref-doc-links

aajtodd
aajtodd approved these changes Oct 5, 2022
View reviewed changes
Copy link
Contributor

@aajtodd aajtodd left a comment

Choose a reason for hiding this comment

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

Looks like services are failing to build in the service check batch job. Needs fixed/investigated before merge.

gradle.properties Outdated
@@ -2,6 +2,9 @@ kotlin.code.style=official
kotlin.mpp.stability.nowarn=true
kotlin.native.ignoreDisabledTargets=true

# FIXME - workaround for https://github.com/Kotlin/dokka/issues/2679
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we actually want this enabled in all of our projects and don't need a FIXME comment here if I'm understanding the compatibility docs.

@github-actions
Copy link

github-actions bot commented Oct 5, 2022

A new generated diff is ready to view: __generated-main...__generated-fix-api-ref-doc-links

@github-actions
Copy link

github-actions bot commented Oct 5, 2022

A new generated diff is ready to view: __generated-main...__generated-fix-api-ref-doc-links

@github-actions
Copy link

github-actions bot commented Oct 5, 2022

A new generated diff is ready to view: __generated-main...__generated-fix-api-ref-doc-links

@github-actions
Copy link

github-actions bot commented Oct 5, 2022

A new generated diff is ready to view: __generated-main...__generated-fix-api-ref-doc-links

@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 6, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@github-actions
Copy link

github-actions bot commented Oct 6, 2022

A new generated diff is ready to view: __generated-main...__generated-fix-api-ref-doc-links

@ianbotsf ianbotsf merged commit fccaffa into main Oct 6, 2022
@ianbotsf ianbotsf deleted the fix-api-ref-doc-links branch October 6, 2022 20:18
@ianbotsf ianbotsf mentioned this pull request Oct 14, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aajtodd aajtodd aajtodd approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ianbotsf @aajtodd