You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/07/21 17:16:00 UTC
[jira] [Commented] (BEAM-2655) Improve Python API reference
generation
[ https://issues.apache.org/jira/browse/BEAM-2655?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16096544#comment-16096544 ]
ASF GitHub Bot commented on BEAM-2655:
--------------------------------------
GitHub user davidcavazos opened a pull request:
https://github.com/apache/beam/pull/3613
[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 https://github.com/davidcavazos/beam pydoc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/beam/pull/3613.patch
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 <dc...@google.com>
Date: 2017-07-21T16:58:11Z
Changed sphinx API reference theme
commit b3275af572aced372bd027763b1eb89230926053
Author: David Cavazos <dc...@google.com>
Date: 2017-07-21T16:59:30Z
Fixed broken type cross references
----
> Improve Python API reference generation
> ---------------------------------------
>
> Key: BEAM-2655
> URL: https://issues.apache.org/jira/browse/BEAM-2655
> 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
(v6.4.14#64029)