On Thu, 20 Jul 2023 at 17:47, Michael A. Smith <mich...@smith-li.com> 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 <mgrigo...@apache.org> > 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 <mich...@smith-li.com> > 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 > > > >
