Use javadoc-extension #1914
Use javadoc-extension #1914
Conversation
Signed-off-by: Tran Ngoc Nhan <[email protected]>
spring-projects-issues
added
the
status: waiting-for-triage
Signed-off-by: Tran Ngoc Nhan <[email protected]>
Signed-off-by: Tran Ngoc Nhan <[email protected]>
jgrandja
added
type: enhancement
There was a problem hiding this comment.
Thanks for the PR @ngocnhan-tran1996. Please see review comments.
| "spring-authorization-server-version": project.version | ||
| 'spring-authorization-server-version': project.version, | ||
| 'spring-security-reference-base-url': "https://docs.spring.io/spring-security/reference/${generateVersionWithoutPatch(springSecurityVersion)}".toString(), | ||
| 'javadoc-location-org-springframework-security': "https://docs.spring.io/spring-security/site/docs/$springSecurityVersion/api".toString(), |
There was a problem hiding this comment.
I'm not sure if this is correct?
I reviewed the changes in Spring Security spring-security#15386 and the gradle task syncAntoraAttachments was added which copies the javadoc as an asset to the site. I'm wondering if we need to do the same here?
@rwinch Is there a way to copy the Spring Security javadoc as an asset to the Spring Authorization Server site docs and reference it via a site asset? Or is this correct by directly referencing the Spring Security javadoc site?
There was a problem hiding this comment.
@rwinch As a side note, it appears syncAntoraAttachments is a required gradle task otherwise the antora build will fail saying it cannot find the javadoc resource. For example, after adding javadoc:org.springframework.security.oauth2.server.authorization.OAuth2AuthorizationCode[], the build will fail unless I add the syncAntoraAttachments task. However, this is not documented in Javadoc, unless I'm missing something?
There was a problem hiding this comment.
If we have the way copy the Spring Security javadoc to to the Spring Authorization Server, please let me know
The main points:
javadoc:org.springframework.security...instead{spring-security-api-base-url}...