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 changes to simplify this soon... I suspect that the solution is going to look something like what Flink does: two separate static websites: one for the community and one (well, one-per) for the release, but they should look and feel integrated. These python docs should be generated for the per-release pages. There's a JIRA to investigate this, and I'm definitely on the low end of this learning curve, but I think it should be doable! All my best, Ryan On Fri, Jul 21, 2023 at 9:35 AM Martin Grigorov <[email protected]> wrote: > > On Thu, Jul 20, 2023 at 7:20 PM Michael A. Smith <[email protected]> > 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 <[email protected]> > > wrote: > > > > > > On Thu, 20 Jul 2023 at 17:47, Michael A. Smith <[email protected]> > > 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 reasonable? > > > > > > > > > Yep! > > > > > > > > > > > > > > On Thu, Jul 20, 2023 at 2:30 AM Martin Grigorov <[email protected]> > > > > wrote: > > > > > > > > > > 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-d54d69dbb27e75dae25cb4b2384310cb57707e419377cf572d5cb0ecc1f16877R76-R162 > > > > > You need to add a new CI job that installs Sphinx, make and other > > > > > dependencies, then call "make" and finally upload the HTMLs. Later > > in the > > > > > push-website job you need to download the HTMLs and copy them to > > > > > website/docs/++version++/api/py > > > > > > > > > > Let me know if you have any questions! > > > > > > > > > > Regards, > > > > > Martin > > > > > > > > > > On Thu, Jul 20, 2023 at 5:10 AM Michael Smith <[email protected]> > > > > wrote: > > > > > > > > > > > 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 the Python API > > docs > > > > the > > > > > > expected way, so they end up on the left navigation, following C# > > API > > > > on > > > > > > avro.apache.org. > > > > > > > > > > > > Can someone check that for me? > > > > > > > > > > > > Thanks, > > > > > > Michael > > > > > > > > > > > >
