Skip to content

Conversation

@kggilmer
Copy link
Contributor

Issue #

#373

Description of changes

  • Enable cross repo docs.
  • Rename dokka html content dir.
  • Allow specification of doc dir on commandline.
  • Misc cleanup.

NOTE: this PR does not implement the backup strategy of per-service doc generation, however includes a gradle change (specify output dir on commandline) necessary to support that if it becomes The Way.

Demo: <job currently running, will update once complete>

Scope

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

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

@kggilmer kggilmer requested review from aajtodd and ianbotsf October 29, 2021 22:57
// Configure Dokka to link to smithy-kotlin types
dokkaSourceSets.configureEach {
externalDocumentationLink {
packageListUrl.set(URL("https://raw.githubusercontent.com/awslabs/smithy-kotlin/api-docs/package-list"))
Copy link
Contributor

Choose a reason for hiding this comment

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

question

Presumably this will need to change to the gh pages branch?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

api-docs is the branch name I've been going with for. Have something better in mind?

@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 3, 2021

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
0.0% 0.0% Duplication

@kggilmer kggilmer merged commit d634ec1 into main Nov 3, 2021
@kggilmer kggilmer deleted the feat-dokka-polish branch November 3, 2021 15:51
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

Successfully merging this pull request may close these issues.

3 participants