You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@beam.apache.org by Lynn Root <ly...@spotify.com> on 2020/09/09 00:18:48 UTC

Ability to link to "latest" of python docs

Hey folks -

I'm wondering if there's a way to link to the latest SDK version of the
Python documentation. I see that if I go here
<https://beam.apache.org/releases/pydoc/>, it lists all the available
documented SDK versions. But it'd be really nice to go to a link like "
https://beam.apache.org/releases/pydoc/latest" and be automatically pointed
to the latest one. This is particularly handy for documenting libraries
that use beam via intersphinx mapping
<https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>.

Thanks!

-- 
Lynn Root
Staff Engineer, Spotify

Re: Ability to link to "latest" of python docs

Posted by Lynn Root <ly...@spotify.com>.
Hey Brian - 100% this is what I was looking for! It works with intersphinx
mapping just fine (looks like it handles redirects). Thanks so much!

On Thu, Sep 10, 2020 at 1:50 PM Brian Hulette <bh...@google.com> wrote:

> There's https://beam.apache.org/releases/pydoc/current (and
> https://beam.apache.org/releases/javadoc/current) which redirect to the
> most recent release. These get updated somewhere in the release process.
>
> They're not very discoverable since it's a redirect and the URL changes
> when you click on it, but maybe that can still work for intersphinx mapping?
>
> Brian
>
> On Tue, Sep 8, 2020 at 7:54 PM Austin Bennett <wh...@gmail.com>
> wrote:
>
>> +dev <de...@beam.apache.org>
>>
>> Lynn,
>>
>> Seems totally doable.  If others don't speak up with a good way to do
>> this (or in opposition), I'm sure we can sort something out to accomplish
>> this (will dig into intersphinx mapping tomorrow).
>>
>> Cheers,
>> Austin
>>
>>
>>
>>
>> On Tue, Sep 8, 2020, 5:19 PM Lynn Root <ly...@spotify.com> wrote:
>>
>>> Hey folks -
>>>
>>> I'm wondering if there's a way to link to the latest SDK version of the
>>> Python documentation. I see that if I go here
>>> <https://beam.apache.org/releases/pydoc/>, it lists all the available
>>> documented SDK versions. But it'd be really nice to go to a link like "
>>> https://beam.apache.org/releases/pydoc/latest" and be automatically
>>> pointed to the latest one. This is particularly handy for documenting
>>> libraries that use beam via intersphinx mapping
>>> <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>
>>> .
>>>
>>> Thanks!
>>>
>>> --
>>> Lynn Root
>>> Staff Engineer, Spotify
>>>
>>

-- 
Lynn Root
Staff Engineer, DI NYC | FOSS Board

Re: Ability to link to "latest" of python docs

Posted by Lynn Root <ly...@spotify.com>.
Hey Brian - 100% this is what I was looking for! It works with intersphinx
mapping just fine (looks like it handles redirects). Thanks so much!

On Thu, Sep 10, 2020 at 1:50 PM Brian Hulette <bh...@google.com> wrote:

> There's https://beam.apache.org/releases/pydoc/current (and
> https://beam.apache.org/releases/javadoc/current) which redirect to the
> most recent release. These get updated somewhere in the release process.
>
> They're not very discoverable since it's a redirect and the URL changes
> when you click on it, but maybe that can still work for intersphinx mapping?
>
> Brian
>
> On Tue, Sep 8, 2020 at 7:54 PM Austin Bennett <wh...@gmail.com>
> wrote:
>
>> +dev <de...@beam.apache.org>
>>
>> Lynn,
>>
>> Seems totally doable.  If others don't speak up with a good way to do
>> this (or in opposition), I'm sure we can sort something out to accomplish
>> this (will dig into intersphinx mapping tomorrow).
>>
>> Cheers,
>> Austin
>>
>>
>>
>>
>> On Tue, Sep 8, 2020, 5:19 PM Lynn Root <ly...@spotify.com> wrote:
>>
>>> Hey folks -
>>>
>>> I'm wondering if there's a way to link to the latest SDK version of the
>>> Python documentation. I see that if I go here
>>> <https://beam.apache.org/releases/pydoc/>, it lists all the available
>>> documented SDK versions. But it'd be really nice to go to a link like "
>>> https://beam.apache.org/releases/pydoc/latest" and be automatically
>>> pointed to the latest one. This is particularly handy for documenting
>>> libraries that use beam via intersphinx mapping
>>> <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>
>>> .
>>>
>>> Thanks!
>>>
>>> --
>>> Lynn Root
>>> Staff Engineer, Spotify
>>>
>>

-- 
Lynn Root
Staff Engineer, DI NYC | FOSS Board

Re: Ability to link to "latest" of python docs

Posted by Brian Hulette <bh...@google.com>.
There's https://beam.apache.org/releases/pydoc/current (and
https://beam.apache.org/releases/javadoc/current) which redirect to the
most recent release. These get updated somewhere in the release process.

They're not very discoverable since it's a redirect and the URL changes
when you click on it, but maybe that can still work for intersphinx mapping?

Brian

On Tue, Sep 8, 2020 at 7:54 PM Austin Bennett <wh...@gmail.com>
wrote:

> +dev <de...@beam.apache.org>
>
> Lynn,
>
> Seems totally doable.  If others don't speak up with a good way to do this
> (or in opposition), I'm sure we can sort something out to accomplish this
> (will dig into intersphinx mapping tomorrow).
>
> Cheers,
> Austin
>
>
>
>
> On Tue, Sep 8, 2020, 5:19 PM Lynn Root <ly...@spotify.com> wrote:
>
>> Hey folks -
>>
>> I'm wondering if there's a way to link to the latest SDK version of the
>> Python documentation. I see that if I go here
>> <https://beam.apache.org/releases/pydoc/>, it lists all the available
>> documented SDK versions. But it'd be really nice to go to a link like "
>> https://beam.apache.org/releases/pydoc/latest" and be automatically
>> pointed to the latest one. This is particularly handy for documenting
>> libraries that use beam via intersphinx mapping
>> <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>.
>>
>> Thanks!
>>
>> --
>> Lynn Root
>> Staff Engineer, Spotify
>>
>

Re: Ability to link to "latest" of python docs

Posted by Brian Hulette <bh...@google.com>.
There's https://beam.apache.org/releases/pydoc/current (and
https://beam.apache.org/releases/javadoc/current) which redirect to the
most recent release. These get updated somewhere in the release process.

They're not very discoverable since it's a redirect and the URL changes
when you click on it, but maybe that can still work for intersphinx mapping?

Brian

On Tue, Sep 8, 2020 at 7:54 PM Austin Bennett <wh...@gmail.com>
wrote:

> +dev <de...@beam.apache.org>
>
> Lynn,
>
> Seems totally doable.  If others don't speak up with a good way to do this
> (or in opposition), I'm sure we can sort something out to accomplish this
> (will dig into intersphinx mapping tomorrow).
>
> Cheers,
> Austin
>
>
>
>
> On Tue, Sep 8, 2020, 5:19 PM Lynn Root <ly...@spotify.com> wrote:
>
>> Hey folks -
>>
>> I'm wondering if there's a way to link to the latest SDK version of the
>> Python documentation. I see that if I go here
>> <https://beam.apache.org/releases/pydoc/>, it lists all the available
>> documented SDK versions. But it'd be really nice to go to a link like "
>> https://beam.apache.org/releases/pydoc/latest" and be automatically
>> pointed to the latest one. This is particularly handy for documenting
>> libraries that use beam via intersphinx mapping
>> <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>.
>>
>> Thanks!
>>
>> --
>> Lynn Root
>> Staff Engineer, Spotify
>>
>

Re: Ability to link to "latest" of python docs

Posted by Austin Bennett <wh...@gmail.com>.
+dev <de...@beam.apache.org>

Lynn,

Seems totally doable.  If others don't speak up with a good way to do this
(or in opposition), I'm sure we can sort something out to accomplish this
(will dig into intersphinx mapping tomorrow).

Cheers,
Austin




On Tue, Sep 8, 2020, 5:19 PM Lynn Root <ly...@spotify.com> wrote:

> Hey folks -
>
> I'm wondering if there's a way to link to the latest SDK version of the
> Python documentation. I see that if I go here
> <https://beam.apache.org/releases/pydoc/>, it lists all the available
> documented SDK versions. But it'd be really nice to go to a link like "
> https://beam.apache.org/releases/pydoc/latest" and be automatically
> pointed to the latest one. This is particularly handy for documenting
> libraries that use beam via intersphinx mapping
> <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>.
>
> Thanks!
>
> --
> Lynn Root
> Staff Engineer, Spotify
>

Re: Ability to link to "latest" of python docs

Posted by Austin Bennett <wh...@gmail.com>.
+dev <de...@beam.apache.org>

Lynn,

Seems totally doable.  If others don't speak up with a good way to do this
(or in opposition), I'm sure we can sort something out to accomplish this
(will dig into intersphinx mapping tomorrow).

Cheers,
Austin




On Tue, Sep 8, 2020, 5:19 PM Lynn Root <ly...@spotify.com> wrote:

> Hey folks -
>
> I'm wondering if there's a way to link to the latest SDK version of the
> Python documentation. I see that if I go here
> <https://beam.apache.org/releases/pydoc/>, it lists all the available
> documented SDK versions. But it'd be really nice to go to a link like "
> https://beam.apache.org/releases/pydoc/latest" and be automatically
> pointed to the latest one. This is particularly handy for documenting
> libraries that use beam via intersphinx mapping
> <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>.
>
> Thanks!
>
> --
> Lynn Root
> Staff Engineer, Spotify
>