JavaDoc for the Asciidoctor Java libraries

classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

JavaDoc for the Asciidoctor Java libraries

mojavelinux
Administrator
I'd like to host or link to the JavaDoc for the Asciidoctor Java libraries.

One solution is to link to the JavaDoc that is exposed via the Maven central repo:


That's nice because it's easy to maintain...just update the main link when a new release is available and add a new link to the history list.

I'm pretty sure the content displayed is exactly what's contained in the javadoc artifact. The only downside is that we can't update the style for old versions. I guess the other downside is the URL is not so pretty, but if we link to it that's not much of a problem.

WDYT? Is the best solution just to link there for now?

-Dan

--
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: JavaDoc for the Asciidoctor Java libraries

LightGuardjp
Administrator
We're already using an awestruct site, why not just scrape the URL and rework it?


On Thu, May 23, 2013 at 12:14 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I'd like to host or link to the JavaDoc for the Asciidoctor Java libraries.

One solution is to link to the JavaDoc that is exposed via the Maven central repo:


That's nice because it's easy to maintain...just update the main link when a new release is available and add a new link to the history list.

I'm pretty sure the content displayed is exactly what's contained in the javadoc artifact. The only downside is that we can't update the style for old versions. I guess the other downside is the URL is not so pretty, but if we link to it that's not much of a problem.

WDYT? Is the best solution just to link there for now?

-Dan

--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: JavaDoc for the Asciidoctor Java libraries

mojavelinux
Administrator
W
​ell, the reasoning is...if it's already on the net, why not link to it?

-Dan​


On Thu, May 23, 2013 at 12:37 PM, lightguard.jp [via Asciidoctor :: Discussion] <[hidden email]> wrote:
We're already using an awestruct site, why not just scrape the URL and rework it?


On Thu, May 23, 2013 at 12:14 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I'd like to host or link to the JavaDoc for the Asciidoctor Java libraries.

One solution is to link to the JavaDoc that is exposed via the Maven central repo:


That's nice because it's easy to maintain...just update the main link when a new release is available and add a new link to the history list.

I'm pretty sure the content displayed is exactly what's contained in the javadoc artifact. The only downside is that we can't update the style for old versions. I guess the other downside is the URL is not so pretty, but if we link to it that's not much of a problem.

WDYT? Is the best solution just to link there for now?

-Dan

--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p229.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: JavaDoc for the Asciidoctor Java libraries

LightGuardjp
Administrator
You were talking about changing the css or something I thought.


On Thu, May 23, 2013 at 12:54 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
W
​ell, the reasoning is...if it's already on the net, why not link to it?

-Dan​


On Thu, May 23, 2013 at 12:37 PM, lightguard.jp [via Asciidoctor :: Discussion] <[hidden email]> wrote:
We're already using an awestruct site, why not just scrape the URL and rework it?


On Thu, May 23, 2013 at 12:14 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I'd like to host or link to the JavaDoc for the Asciidoctor Java libraries.

One solution is to link to the JavaDoc that is exposed via the Maven central repo:


That's nice because it's easy to maintain...just update the main link when a new release is available and add a new link to the history list.

I'm pretty sure the content displayed is exactly what's contained in the javadoc artifact. The only downside is that we can't update the style for old versions. I guess the other downside is the URL is not so pretty, but if we link to it that's not much of a problem.

WDYT? Is the best solution just to link there for now?

-Dan

--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p229.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p230.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: JavaDoc for the Asciidoctor Java libraries

mojavelinux
Administrator
Right, but then we would just add the JavaDoc build into the Awestruct build rather than scrape.

I think short term solution the best is just to link to it. Then, we can change to a local build once we outgrow it.

I'll add the JavaDoc link to the docs page now.

-Dan


On Thu, May 23, 2013 at 12:59 PM, lightguard.jp [via Asciidoctor :: Discussion] <[hidden email]> wrote:
You were talking about changing the css or something I thought.


On Thu, May 23, 2013 at 12:54 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
W
​ell, the reasoning is...if it's already on the net, why not link to it?

-Dan​


On Thu, May 23, 2013 at 12:37 PM, lightguard.jp [via Asciidoctor :: Discussion] <[hidden email]> wrote:
We're already using an awestruct site, why not just scrape the URL and rework it?


On Thu, May 23, 2013 at 12:14 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I'd like to host or link to the JavaDoc for the Asciidoctor Java libraries.

One solution is to link to the JavaDoc that is exposed via the Maven central repo:


That's nice because it's easy to maintain...just update the main link when a new release is available and add a new link to the history list.

I'm pretty sure the content displayed is exactly what's contained in the javadoc artifact. The only downside is that we can't update the style for old versions. I guess the other downside is the URL is not so pretty, but if we link to it that's not much of a problem.

WDYT? Is the best solution just to link there for now?

-Dan

--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p229.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p230.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p231.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: JavaDoc for the Asciidoctor Java libraries

LightGuardjp
Administrator
running the build from awestruct is fine, but you probably won't get it to work on travis, unless you're running the jruby version.


On Thu, May 23, 2013 at 1:28 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
Right, but then we would just add the JavaDoc build into the Awestruct build rather than scrape.

I think short term solution the best is just to link to it. Then, we can change to a local build once we outgrow it.

I'll add the JavaDoc link to the docs page now.

-Dan


On Thu, May 23, 2013 at 12:59 PM, lightguard.jp [via Asciidoctor :: Discussion] <[hidden email]> wrote:
You were talking about changing the css or something I thought.


On Thu, May 23, 2013 at 12:54 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
W
​ell, the reasoning is...if it's already on the net, why not link to it?

-Dan​


On Thu, May 23, 2013 at 12:37 PM, lightguard.jp [via Asciidoctor :: Discussion] <[hidden email]> wrote:
We're already using an awestruct site, why not just scrape the URL and rework it?


On Thu, May 23, 2013 at 12:14 PM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I'd like to host or link to the JavaDoc for the Asciidoctor Java libraries.

One solution is to link to the JavaDoc that is exposed via the Maven central repo:


That's nice because it's easy to maintain...just update the main link when a new release is available and add a new link to the history list.

I'm pretty sure the content displayed is exactly what's contained in the javadoc artifact. The only downside is that we can't update the style for old versions. I guess the other downside is the URL is not so pretty, but if we link to it that's not much of a problem.

WDYT? Is the best solution just to link there for now?

-Dan

--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p229.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p230.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p231.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p233.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: JavaDoc for the Asciidoctor Java libraries

asotobu
I have got an issue to change javadoc format to AsciiDoc and then use asciidoclet to create the javadocs. Now I am focusing in resolving other kind of issues, if you want when I start working on integrating asciidoctor doclet into AJI I notify you so we can prepare something to publish the javadocs with the asciidoctor css file.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: JavaDoc for the Asciidoctor Java libraries

LightGuardjp
Administrator
Haven't tried yet

Sent from Mailbox for iPhone


On Fri, May 24, 2013 at 12:47 AM, asotobu [via Asciidoctor :: Discussion] <[hidden email]> wrote:

I have got an issue to change javadoc format to AsciiDoc and then use asciidoclet to create the javadocs. Now I am focusing in resolving other kind of issues, if you want when I start working on integrating asciidoctor doclet into AJI I notify you so we can prepare something to publish the javadocs with the asciidoctor css file.


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/JavaDoc-for-the-Asciidoctor-Java-libraries-tp228p235.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: JavaDoc for the Asciidoctor Java libraries

johncarl81
Dan,

I like the idea of hosting the javadocs directly out of Maven Central.  (I liked it so much, I just switched Transfuse to use this strat).  We can use the deployed javadocs for Asciidoclet as an example as well when those get published to Maven Central.

John
Loading...