Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Automatically publish JavaDoc as a functioning website on remote machine

Is there a way of automatically publishing as live website javadocs after uploading it to Nexus Maven repository? I have some packages, which are under constant development and I'd like to have the docs for them available for browsing by other team members straight after uploading updated code to our remote repository.

Is there any ready solution for doing that or would I have to write say a shell script (executed by Maven after successfull deployment of the code to the remote repo), which would copy the docs to a remote location on a web server?

I know that Nexus Professional allows to view javadocs out of the box, but even for 10 users it is a bit pricey, so I'd appreciate a different solution :-)

I'm using Eclipse@Windows + Maven 2.

Thanks!

like image 917
Farrkhar Avatar asked Jan 10 '23 08:01

Farrkhar


1 Answers

If your project is open-source and is released to Maven Central then your javadoc will be available at javadoc.io automatically.

The url is of the form: http://www.javadoc.io/doc/[groupId]/[artifactId]. For example, I have my javadoc for my project at www.javadoc.io/doc/me.ramswaroop.jbot/jbot

like image 61
Ram Patra Avatar answered Apr 26 '23 16:04

Ram Patra