beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <>
Subject [jira] [Commented] (BEAM-2655) Improve Python API reference generation
Date Fri, 21 Jul 2017 17:16:00 GMT


ASF GitHub Bot commented on BEAM-2655:

GitHub user davidcavazos opened a pull request:

    [BEAM-2655] Makes Python API reference generation more strict

    This changes the Python API reference theme to something more readable. It also makes
cross reference checking more strict and fixes all the broken cross references. Pages are
also now separated by files and the affected docs were reformatted to respect the reStructuredText
format that Sphinx expects.

You can merge this pull request into a Git repository by running:

    $ git pull pydoc

Alternatively you can review and apply these changes as the patch at:

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #3613
commit 04fbd1de89ce401c3f3c265b3a8476233aaa8d22
Author: David Cavazos <>
Date:   2017-07-21T16:58:11Z

    Changed sphinx API reference theme

commit b3275af572aced372bd027763b1eb89230926053
Author: David Cavazos <>
Date:   2017-07-21T16:59:30Z

    Fixed broken type cross references


> Improve Python API reference generation
> ---------------------------------------
>                 Key: BEAM-2655
>                 URL:
>             Project: Beam
>          Issue Type: Improvement
>          Components: sdk-py
>            Reporter: David Cavazos
>            Assignee: Ahmet Altay
>            Priority: Minor
> Changes the theme to something more readable and pleasing to the eyes. Makes sphinx do
strict checking on pydoc cross references and fix the broken links.

This message was sent by Atlassian JIRA

View raw message