Re: Implementing Python API Docs

2023-07-21 Thread Michael A. Smith
> or you mean something else? I actually meant how to test it integrated with the rest of the website build. There's no `doc` command for the root ./build.sh. I've been playing with the part of that file that might become a standalone doc command, but it is failing on a lot of stuff (probably macO

Re: Implementing Python API Docs

2023-07-21 Thread Michael A. Smith
> + mkdir -p $doc_dir Ah of course, thanks. I'll get that in. > I see that the "dist' target creates a virtual environment automatically. So it does. I didn't realize (or had forgotten). A bunch of the other commands in `build.sh` use tox and don't create a virtualenv. It's tox that creates mos

Re: Implementing Python API Docs

2023-07-21 Thread Martin Grigorov
On Fri, Jul 21, 2023 at 10:47 PM Martin Grigorov wrote: > > > On Fri, Jul 21, 2023 at 10:18 PM Michael A. Smith > wrote: > >> I did the cherry-pick, but I'm not sure I know how to test if it >> works. https://github.com/apache/avro/pull/2380 > > > git switch branch-1.11 > cd lang/py > ./build.sh

Re: Implementing Python API Docs

2023-07-21 Thread Martin Grigorov
On Fri, Jul 21, 2023 at 10:18 PM Michael A. Smith wrote: > I did the cherry-pick, but I'm not sure I know how to test if it > works. https://github.com/apache/avro/pull/2380 git switch branch-1.11 cd lang/py ./build.sh doc open .../index.html or you mean something else ? > > > On Fri, Jul 2

Re: Implementing Python API Docs

2023-07-21 Thread Michael A. Smith
I did the cherry-pick, but I'm not sure I know how to test if it works. https://github.com/apache/avro/pull/2380 On Fri, Jul 21, 2023 at 4:34 AM Ryan Skraba wrote: > > Hey thanks for this work! Do you think the python doc generation > stuff can be cherry-picked back to 1.11? That would be a nea

Re: Implementing Python API Docs

2023-07-21 Thread Ryan Skraba
Hey thanks for this work! Do you think the python doc generation stuff can be cherry-picked back to 1.11? That would be a neat addition to the website for the incoming 1.11.3! Building and deploying the website today is a really tricky problem... I think we're going to have to make some major ch

Re: Implementing Python API Docs

2023-07-21 Thread Martin Grigorov
On Thu, Jul 20, 2023 at 7:20 PM Michael A. Smith wrote: > OK, I've merged that PR and have made suggested changes to #2187. > Please let me know how I can help. > Thanks ! Hopefully this PR will be merged soon! > > On Thu, Jul 20, 2023 at 11:27 AM Martin Grigorov > wrote: > > > > On Thu, 20

Re: Implementing Python API Docs

2023-07-20 Thread Michael A. Smith
OK, I've merged that PR and have made suggested changes to #2187. Please let me know how I can help. On Thu, Jul 20, 2023 at 11:27 AM Martin Grigorov wrote: > > On Thu, 20 Jul 2023 at 17:47, Michael A. Smith wrote: > > > Thanks, Martin, > > > > It seems like since that PR isn't merged yet, and i

Re: Implementing Python API Docs

2023-07-20 Thread Martin Grigorov
On Thu, 20 Jul 2023 at 17:47, Michael A. Smith wrote: > Thanks, Martin, > > It seems like since that PR isn't merged yet, and it would be > complicated to add all the Sphinx stuff to it, I should merge my > changes first, and then add the Python stuff to #2187 after that. > > Does that seem reaso

Re: Implementing Python API Docs

2023-07-20 Thread Michael A. Smith
Thanks, Martin, It seems like since that PR isn't merged yet, and it would be complicated to add all the Sphinx stuff to it, I should merge my changes first, and then add the Python stuff to #2187 after that. Does that seem reasonable? On Thu, Jul 20, 2023 at 2:30 AM Martin Grigorov wrote: > >

Re: Implementing Python API Docs

2023-07-19 Thread Martin Grigorov
Hi Michael, The new website uses Hugo to build the static files. If you prefer to use Sphinx for the Python docs then I suggest to follow the way of C/C++/C#/Java SDKs contribute their part of the docs in this PR - https://github.com/apache/avro/pull/2187/files#diff-d54d69dbb27e75dae25cb4b2384310c

Implementing Python API Docs

2023-07-19 Thread Michael Smith
I did a PR to implement a very old ticket, AVRO-312. https://github.com/apache/avro/pull/2370 It builds the documentation in html and I can view it locally. What I need is for someone who understands the process for publishing the avro website to let me know if my changes will properly publish th