Doclava integration #12
Conversation
.github/CONTRIBUTING.md Outdated
| this Maven profile by running the following command: | ||
| | ||
| ``` | ||
| mvn site -Ddevsite.template=path/to/templates |
There was a problem hiding this comment.
Can you provide guidance on what path/to/templates should be?
There was a problem hiding this comment.
Added a bit more info.
There was a problem hiding this comment.
LGTM if you undo what I asked you to do. :-) [sorry, I forgot we can't point to the right directory to use].
We should separately update (or create?) internal docs to describe how to build / release the SDK and docs, including the right devsite path to use, etc.
.github/CONTRIBUTING.md Outdated
| | ||
| The `devsite.template` property should point to a directory consisting of Clearsilver templates | ||
| for formatting the API docs. This command will place the generated API docs in the `target/apidocs` | ||
| directory. |
There was a problem hiding this comment.
Sorry. You can probably remove this. I think the above paragraph is already enough. I was hoping we could explicitly point to the right templates to use, but I forgot we can't since this is going to be open source.
Also, in the paragraph you added you say "target/apidocs" but in the previous paragraph it says "target/site/apidocs" so please make sure to keep whichever one is correct. :-)
There was a problem hiding this comment.
Removed the extra text. The two plugins use slightly different output locations (target/site/apidocs and target/apidocs). So the instructions are correct.
2 participants
No description provided.