You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pekko.apache.org by PJ Fanning <fa...@apache.org> on 2023/01/21 15:18:40 UTC
pekko java/scala docs
Hi everyone,
I published the main incubator-pekko docs to
https://pekko.staged.apache.org and https://pekko.apache.org.
I didn't worry about the paths - I was just testing that the publishing worked.
So far, I'm trying to follow the path standards used on https://docs.akka.io.
Would anyone know how to generate the api and japi html like those on
https://akka.io/docs/ without the rsyncPublish?
`sbt doc` produces scaladoc html but it is distributed across the
module target dirs.
I'm assuming that there must be something easier than me scripting up
something new to do this.
Regards,
PJ
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
For additional commands, e-mail: dev-help@pekko.apache.org
Re: pekko java/scala docs
Posted by Johannes Rudolph <jo...@gmail.com>.
On Mon, Jan 23, 2023 at 1:14 AM PJ Fanning <fa...@gmail.com> wrote:
> "sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc”
>
> In incubator-pekko, it seems to fail with Java 8 but runs ok with Java 11.
One could just remove the check for Java 11 in `project/Doc.scala` in
theory and it would still work. IIRC the reason to build (especially
the Javadoc) with JDK 11 is that it then gets the more modern Javadoc
rendering.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
For additional commands, e-mail: dev-help@pekko.apache.org
Re: pekko java/scala docs
Posted by PJ Fanning <fa...@gmail.com>.
Thanks Tim.
That works in incubator-pekko repo too. The system property has been
renamed in that repo.
"sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc”
In incubator-pekko, it seems to fail with Java 8 but runs ok with Java 11.
On Sun, 22 Jan 2023 at 23:34, Tim Moore <tm...@incrementalism.net> wrote:
>
> Try this https://doc.akka.io/docs/akka-http/10.0/contributing.html#javadoc
>
> "sbt -Dakka.genjavadoc.enabled=true javaunidoc:doc”
>
> That’s from the Akka HTTP docs, but it looks like it should be the same for the core project. It’s looking for that property here:
> https://github.com/apache/incubator-pekko/blob/b6a8e2204bcdd3a96101d16b6d003c37d57a0f36/project/Doc.scala#LL137C45-L137C62
>
> I believe that "sbt -Dakka.genjavadoc.enabled=true unidoc” should then generate both unified ScalaDoc and unified JavaDoc in the same run, but I can’t test it right now.
>
> Best,
> Tim
>
> > On 23 Jan 2023, at 5:39 am, PJ Fanning <fa...@gmail.com> wrote:
> >
> > Thanks Tim. That `abt unidoc` gets me the unified Scaladoc which
> > definitely helps. I still haven't worked out how to build the Java API
> > equivalent. sbt-unidoc does document some stuff but I might need to
> > enable more plugin settings in the build.sbt.
> >
> > On Sun, 22 Jan 2023 at 02:53, Tim Moore <tm...@incrementalism.net> wrote:
> >>
> >> I think ’sbt unidoc’ should do it
> >>
> >> Best,
> >> Tim
> >>
> >>> On 22 Jan 2023, at 1:48 am, PJ Fanning <fa...@apache.org> wrote:
> >>>
> >>> Hi everyone,
> >>> I published the main incubator-pekko docs to
> >>> https://pekko.staged.apache.org and https://pekko.apache.org.
> >>> I didn't worry about the paths - I was just testing that the publishing worked.
> >>>
> >>> So far, I'm trying to follow the path standards used on https://docs.akka.io.
> >>>
> >>> Would anyone know how to generate the api and japi html like those on
> >>> https://akka.io/docs/ without the rsyncPublish?
> >>>
> >>> `sbt doc` produces scaladoc html but it is distributed across the
> >>> module target dirs.
> >>>
> >>> I'm assuming that there must be something easier than me scripting up
> >>> something new to do this.
> >>>
> >>> Regards,
> >>> PJ
> >>>
> >>> ---------------------------------------------------------------------
> >>> To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
> >>> For additional commands, e-mail: dev-help@pekko.apache.org
> >>>
> >>
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
> >> For additional commands, e-mail: dev-help@pekko.apache.org
> >>
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
> > For additional commands, e-mail: dev-help@pekko.apache.org
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
> For additional commands, e-mail: dev-help@pekko.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
For additional commands, e-mail: dev-help@pekko.apache.org
Re: pekko java/scala docs
Posted by Tim Moore <tm...@incrementalism.net>.
Try this https://doc.akka.io/docs/akka-http/10.0/contributing.html#javadoc
"sbt -Dakka.genjavadoc.enabled=true javaunidoc:doc”
That’s from the Akka HTTP docs, but it looks like it should be the same for the core project. It’s looking for that property here:
https://github.com/apache/incubator-pekko/blob/b6a8e2204bcdd3a96101d16b6d003c37d57a0f36/project/Doc.scala#LL137C45-L137C62
I believe that "sbt -Dakka.genjavadoc.enabled=true unidoc” should then generate both unified ScalaDoc and unified JavaDoc in the same run, but I can’t test it right now.
Best,
Tim
> On 23 Jan 2023, at 5:39 am, PJ Fanning <fa...@gmail.com> wrote:
>
> Thanks Tim. That `abt unidoc` gets me the unified Scaladoc which
> definitely helps. I still haven't worked out how to build the Java API
> equivalent. sbt-unidoc does document some stuff but I might need to
> enable more plugin settings in the build.sbt.
>
> On Sun, 22 Jan 2023 at 02:53, Tim Moore <tm...@incrementalism.net> wrote:
>>
>> I think ’sbt unidoc’ should do it
>>
>> Best,
>> Tim
>>
>>> On 22 Jan 2023, at 1:48 am, PJ Fanning <fa...@apache.org> wrote:
>>>
>>> Hi everyone,
>>> I published the main incubator-pekko docs to
>>> https://pekko.staged.apache.org and https://pekko.apache.org.
>>> I didn't worry about the paths - I was just testing that the publishing worked.
>>>
>>> So far, I'm trying to follow the path standards used on https://docs.akka.io.
>>>
>>> Would anyone know how to generate the api and japi html like those on
>>> https://akka.io/docs/ without the rsyncPublish?
>>>
>>> `sbt doc` produces scaladoc html but it is distributed across the
>>> module target dirs.
>>>
>>> I'm assuming that there must be something easier than me scripting up
>>> something new to do this.
>>>
>>> Regards,
>>> PJ
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
>>> For additional commands, e-mail: dev-help@pekko.apache.org
>>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
>> For additional commands, e-mail: dev-help@pekko.apache.org
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
> For additional commands, e-mail: dev-help@pekko.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
For additional commands, e-mail: dev-help@pekko.apache.org
Re: pekko java/scala docs
Posted by PJ Fanning <fa...@gmail.com>.
Thanks Tim. That `abt unidoc` gets me the unified Scaladoc which
definitely helps. I still haven't worked out how to build the Java API
equivalent. sbt-unidoc does document some stuff but I might need to
enable more plugin settings in the build.sbt.
On Sun, 22 Jan 2023 at 02:53, Tim Moore <tm...@incrementalism.net> wrote:
>
> I think ’sbt unidoc’ should do it
>
> Best,
> Tim
>
> > On 22 Jan 2023, at 1:48 am, PJ Fanning <fa...@apache.org> wrote:
> >
> > Hi everyone,
> > I published the main incubator-pekko docs to
> > https://pekko.staged.apache.org and https://pekko.apache.org.
> > I didn't worry about the paths - I was just testing that the publishing worked.
> >
> > So far, I'm trying to follow the path standards used on https://docs.akka.io.
> >
> > Would anyone know how to generate the api and japi html like those on
> > https://akka.io/docs/ without the rsyncPublish?
> >
> > `sbt doc` produces scaladoc html but it is distributed across the
> > module target dirs.
> >
> > I'm assuming that there must be something easier than me scripting up
> > something new to do this.
> >
> > Regards,
> > PJ
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
> > For additional commands, e-mail: dev-help@pekko.apache.org
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
> For additional commands, e-mail: dev-help@pekko.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
For additional commands, e-mail: dev-help@pekko.apache.org
Re: pekko java/scala docs
Posted by Tim Moore <tm...@incrementalism.net>.
I think ’sbt unidoc’ should do it
Best,
Tim
> On 22 Jan 2023, at 1:48 am, PJ Fanning <fa...@apache.org> wrote:
>
> Hi everyone,
> I published the main incubator-pekko docs to
> https://pekko.staged.apache.org and https://pekko.apache.org.
> I didn't worry about the paths - I was just testing that the publishing worked.
>
> So far, I'm trying to follow the path standards used on https://docs.akka.io.
>
> Would anyone know how to generate the api and japi html like those on
> https://akka.io/docs/ without the rsyncPublish?
>
> `sbt doc` produces scaladoc html but it is distributed across the
> module target dirs.
>
> I'm assuming that there must be something easier than me scripting up
> something new to do this.
>
> Regards,
> PJ
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
> For additional commands, e-mail: dev-help@pekko.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@pekko.apache.org
For additional commands, e-mail: dev-help@pekko.apache.org