Hi Luca,
thanks! Glad to help and give something back to the community!
Il giorno mar 28 nov 2023 alle ore 14:00 Luca Boccassi <
luca.bocca...@gmail.com> ha scritto:
> On Mon, 27 Nov 2023 at 22:56, Francesco
> wrote:
> >
> > Hi all,
> >
> > A final update on the ZeroMQ API documentation
On Mon, 27 Nov 2023 at 22:56, Francesco wrote:
>
> Hi all,
>
> A final update on the ZeroMQ API documentation migration:
>
> > I think on documentation side what's really left is just to update links
> > still indexed by Google and other search engines like:
> >
Hi all,
A final update on the ZeroMQ API documentation migration:
> I think on documentation side what's really left is just to update links
still indexed by Google and other search engines like:
> http://api.zeromq.org/3-2:zmq-connect -->
Hi all,
Another small update on the documentation side, in case you are interested:
>* In zeromq.org website: Update the link "Low-level API" to point to
https://zeromq.readthedocs.io/en/latest/
Done
>* In zeromq.org website: Create a page to host the contents of
hi Brett, hi Arnaud,
> Just to say that this is really great work! Kudos to you and Luca.
...
> I would just like to add that this is really much appreciated work!
Thanks !
I hope that the renewed look (together with the "always up to date with
zero maintainer work") will help to show to a the
I would just like to add that this is really much appreciated work!
I'm also curious how we can make this work from zproject. But that might
be a later step.
Rg,
Arnaud
On 03/11/2023 10:29, Francesco wrote:
Hi all,
As an update on this topic: with help from Luca the *conversion of
Francesco writes:
> Any comment is welcome.
Just to say that this is really great work! Kudos to you and Luca.
-Brett.
signature.asc
Description: PGP signature
___
zeromq-dev mailing list
zeromq-dev@lists.zeromq.org
Hi all,
As an update on this topic: with help from Luca the *conversion of
documentation from the old Asciidoc-py has been completed*.
As bonus: Github is able to render Asciidocs natively, so e.g. you can see
the documentation rendered on the fly by just browsing Github repo, e.g.
see
I'm mostly a lurker and merely a user but:
I have to say ZeroMQ docs have been great for years. If ZeroMQ docs
are on some "not 100% most popular" tool asciidoc instead of markdown.
Maybe the maintainers should just stick with what they like.
Monoculture is not a good thing. If the only GUI on
Hi Brett,
FWIW, I think it is very reasonable to accept some syntax change in
> order to migrate to a better supported document compiler and to gain the
> new functionality of readthedocs. So, for whatever it may be worth, I
> take back my initial opinion to leave the API .txt files as-is.
>
Francesco writes:
> Update: apparently the point a) is blocked by point b).
>
> In more details: the Asciidoc modern syntax to get a cross-reference
> correctly rendered in both manpages and HTMLs is:
>
> xref:name_of_doc.adoc[name_of_doc]
FWIW, I think it is very reasonable to accept some
Update: apparently the point a) is blocked by point b).
In more details: the Asciidoc modern syntax to get a cross-reference
correctly rendered in both manpages and HTMLs is:
xref:name_of_doc.adoc[name_of_doc]
This will produce a valid link to "name_of_doc.html" for HTML output and a
simple
Hi all,
Here's an update on my attempt to refresh the doc system for libzmq API.
*Current status:*
libzmq is built around the "ancient" python Asciidoc tool. That tool is
unmaintained for several years and has been replaced by the Asciidoctor
tool (see
On Fri, Oct 20, 2023 at 12:03 PM Francesco wrote:
>
> Maybe an even simpler solution is to activate the Github "Pages" support in
> libzmq.org and link it with a github action that just uses the Asciidoctor
> generator to convert all of doc/*.txt into static HTML.
>
> What do you think about
Hi Francesco,
the current API docs are indeed served by wikidot. There is a repo
https://github.com/zeromq/ztools which updates the docs. I do have the
permissions to logon and perform the update. I'll do the update sometime
next week.
In regards to the look of the API docs we can all agree they
Maybe an even simpler solution is to activate the Github "Pages" support in
libzmq.org and link it with a github action that just uses the Asciidoctor
generator to convert all of doc/*.txt into static HTML.
What do you think about this?
Il giorno ven 20 ott 2023 alle ore 17:03 Francesco <
hi Brett,
thanks for your answer.
I checked zeromq.org (I had some trouble using Docker to get the website
up: https://github.com/zeromq/zeromq.org/issues/125 and then I installed
locally hugo but I discovered it needs a quite old version 0.57.2 built in
"extended" mode). I'm not really a web
Hi Francesco,
I agree a refresh of the online API docs would be good. I think the
zeromq.org website takes its content from:
https://github.com/zeromq/zeromq.org
A PR to that repo is likely the first step to get zeromq.org updated.
It would be extra good if the API docs for development and
Another point I forgot: I think it would be nice to switch to
https://about.readthedocs.com/ as a way to publish the libzmq API...
Il giorno ven 20 ott 2023 alle ore 12:00 Francesco <
francesco.monto...@gmail.com> ha scritto:
> Hi all,
> I'm happy to see that version 4.3.5 has been published,
19 matches
Mail list logo
