Re: Is there good way to make Python SDK docs draft accessible?
Sorry for late reply. I've checked release process and found following way would be good to make the docs/scripts ready to be reviewed and merged. 1. Create PR for apache/beam-site about docs generated by scripts (hereinafter called PR1) PR1 is intended only to review docs, so it must not to be merged. 2. create PR for apache/beam about modification to docs-generating scripts (hereinafter called PR2) 3. PR1 and PR2 are reviewed and confirmed to be OK, close PR1. 4. Merge PR2. Please let me know if there is a problem. 2019年11月7日(木) 9:17 Valentyn Tymofieiev : > > Hi Yoshiki, > > Were you able to find the information you need to regenerate the > documentation? > > Thanks, > Valentyn > > On Tue, Oct 29, 2019 at 8:01 AM Yoshiki Obata wrote: >> >> Thank you for advising, Udi and Ahmet. >> I'll take a look at the release process. >> >> 2019年10月29日(火) 3:47 Ahmet Altay : >> > >> > Thank you for doing this. It should be possible to run tox as Udi >> > suggested and create a PR for review purposes similar to the release >> > process (see: >> > https://beam.apache.org/contribute/release-guide/#build-the-pydoc-api-reference) >> > >> > /cc +Valentyn Tymofieiev -- This is likely a required item before retiring >> > python 2 support. >> > >> > Ahmet >> > >> > On Mon, Oct 28, 2019 at 11:21 AM Udi Meiri wrote: >> >> >> >> I believe that generating pydoc for the website is still a manual process >> >> (unlike the rest of the website?). >> >> The reviewer will need to manually generate the docs (checkout the PR, >> >> run tox -e docs). >> >> >> >> On Mon, Oct 28, 2019 at 10:55 AM Yoshiki Obata >> >> wrote: >> >>> >> >>> Hi all. >> >>> >> >>> I'm working on enabling to generate Python SDK docs with Python3 [1] >> >>> I have modified scripts and now reviewing generated docs in someone’s >> >>> eyes is needed. >> >>> >> >>> But there seems to be no existing way to upload generated docs to >> >>> where anyone can access unlike website html which can be uploaded to >> >>> GCS via Jenkins job. >> >>> Would anyone know good way to make generated docs accessible for >> >>> anyone for convenience of reviewing them? >> >>> >> >>> [1] https://issues.apache.org/jira/browse/BEAM-7847 >> >>> >> >>> >> >>> Best regards, >> >>> Yoshiki >> >>> >> >>> >> >>> -- >> >>> Yoshiki Obata >> >>> mail: yoshiki.ob...@gmail.com >> >>> gh: https://github.com/lazylynx
Re: Is there good way to make Python SDK docs draft accessible?
Hi Yoshiki, Were you able to find the information you need to regenerate the documentation? Thanks, Valentyn On Tue, Oct 29, 2019 at 8:01 AM Yoshiki Obata wrote: > Thank you for advising, Udi and Ahmet. > I'll take a look at the release process. > > 2019年10月29日(火) 3:47 Ahmet Altay : > > > > Thank you for doing this. It should be possible to run tox as Udi > suggested and create a PR for review purposes similar to the release > process (see: > https://beam.apache.org/contribute/release-guide/#build-the-pydoc-api-reference > ) > > > > /cc +Valentyn Tymofieiev -- This is likely a required item before > retiring python 2 support. > > > > Ahmet > > > > On Mon, Oct 28, 2019 at 11:21 AM Udi Meiri wrote: > >> > >> I believe that generating pydoc for the website is still a manual > process (unlike the rest of the website?). > >> The reviewer will need to manually generate the docs (checkout the PR, > run tox -e docs). > >> > >> On Mon, Oct 28, 2019 at 10:55 AM Yoshiki Obata > wrote: > >>> > >>> Hi all. > >>> > >>> I'm working on enabling to generate Python SDK docs with Python3 [1] > >>> I have modified scripts and now reviewing generated docs in someone’s > >>> eyes is needed. > >>> > >>> But there seems to be no existing way to upload generated docs to > >>> where anyone can access unlike website html which can be uploaded to > >>> GCS via Jenkins job. > >>> Would anyone know good way to make generated docs accessible for > >>> anyone for convenience of reviewing them? > >>> > >>> [1] https://issues.apache.org/jira/browse/BEAM-7847 > >>> > >>> > >>> Best regards, > >>> Yoshiki > >>> > >>> > >>> -- > >>> Yoshiki Obata > >>> mail: yoshiki.ob...@gmail.com > >>> gh: https://github.com/lazylynx >
Re: Is there good way to make Python SDK docs draft accessible?
Thank you for advising, Udi and Ahmet. I'll take a look at the release process. 2019年10月29日(火) 3:47 Ahmet Altay : > > Thank you for doing this. It should be possible to run tox as Udi suggested > and create a PR for review purposes similar to the release process (see: > https://beam.apache.org/contribute/release-guide/#build-the-pydoc-api-reference) > > /cc +Valentyn Tymofieiev -- This is likely a required item before retiring > python 2 support. > > Ahmet > > On Mon, Oct 28, 2019 at 11:21 AM Udi Meiri wrote: >> >> I believe that generating pydoc for the website is still a manual process >> (unlike the rest of the website?). >> The reviewer will need to manually generate the docs (checkout the PR, run >> tox -e docs). >> >> On Mon, Oct 28, 2019 at 10:55 AM Yoshiki Obata >> wrote: >>> >>> Hi all. >>> >>> I'm working on enabling to generate Python SDK docs with Python3 [1] >>> I have modified scripts and now reviewing generated docs in someone’s >>> eyes is needed. >>> >>> But there seems to be no existing way to upload generated docs to >>> where anyone can access unlike website html which can be uploaded to >>> GCS via Jenkins job. >>> Would anyone know good way to make generated docs accessible for >>> anyone for convenience of reviewing them? >>> >>> [1] https://issues.apache.org/jira/browse/BEAM-7847 >>> >>> >>> Best regards, >>> Yoshiki >>> >>> >>> -- >>> Yoshiki Obata >>> mail: yoshiki.ob...@gmail.com >>> gh: https://github.com/lazylynx
Re: Is there good way to make Python SDK docs draft accessible?
I believe that generating pydoc for the website is still a manual process (unlike the rest of the website?). The reviewer will need to manually generate the docs (checkout the PR, run tox -e docs). On Mon, Oct 28, 2019 at 10:55 AM Yoshiki Obata wrote: > Hi all. > > I'm working on enabling to generate Python SDK docs with Python3 [1] > I have modified scripts and now reviewing generated docs in someone’s > eyes is needed. > > But there seems to be no existing way to upload generated docs to > where anyone can access unlike website html which can be uploaded to > GCS via Jenkins job. > Would anyone know good way to make generated docs accessible for > anyone for convenience of reviewing them? > > [1] https://issues.apache.org/jira/browse/BEAM-7847 > > > Best regards, > Yoshiki > > > -- > Yoshiki Obata > mail: yoshiki.ob...@gmail.com > gh: https://github.com/lazylynx > smime.p7s Description: S/MIME Cryptographic Signature
Is there good way to make Python SDK docs draft accessible?
Hi all. I'm working on enabling to generate Python SDK docs with Python3 [1] I have modified scripts and now reviewing generated docs in someone’s eyes is needed. But there seems to be no existing way to upload generated docs to where anyone can access unlike website html which can be uploaded to GCS via Jenkins job. Would anyone know good way to make generated docs accessible for anyone for convenience of reviewing them? [1] https://issues.apache.org/jira/browse/BEAM-7847 Best regards, Yoshiki -- Yoshiki Obata mail: yoshiki.ob...@gmail.com gh: https://github.com/lazylynx
