If I wanted to add a documentation generation step...
# generali
icy-hair-30586
04/05/2022, 4:41 PMIf I wanted to add a documentation generation step with https://pdoc3.github.io/pdoc/ , am I correct to assume that I should handle it as a codegen plugin and start from the codegen tutorial? Is there anything similar for javadoc that I could replicate?
h
hundreds-father-404
04/05/2022, 4:52 PMPossibly, but it might also makes sense to create a custom doc goal. I I don't think we have any special Java Doc integration yet. Do you know already how you would do this without pants, eg the argv to run?
w
witty-crayon-22786
04/05/2022, 5:07 PMit’s also possible that
packageđź’Ż 1
h
happy-kitchen-89482
04/05/2022, 6:14 PMNot sure about that
happy-kitchen-89482
04/05/2022, 6:25 PMOr maybe yes? Can bikeshed 🙂
w
witty-crayon-22786
04/05/2022, 7:28 PMmy thinking with the documentation target is that generally people want a documentation artifact (something that they can
publishâž• 1
witty-crayon-22786
04/05/2022, 7:30 PMalthough Java/Scala support a special artifact type “attached” to a JAR, it’s frequently also the case that people want to publish the documentation to be hosted on an HTTP server, for example.
and that latter case (“documentation artifact”) is a common thread across all languages i’ve encountered… sphinx, javadoc, cargo doc, etc
âž• 1
witty-crayon-22786
04/05/2022, 7:31 PMit’s also usually the case that your published API docs in monorepos are monolithic… repo or project wide, basically. it’s rare for them to be per-library.
h
happy-kitchen-89482
04/06/2022, 12:26 AMTrue, and there is probably artifact-specific config (e.g., HTTP style information) that needs to go somewhere
đź‘Ť 1
3 Views