GitHub user sb2nov opened a pull request:
https://github.com/apache/beam/pull/2024
[BEAM-1320] Add script to generate documentation for the python sdk
R: @aaltay
- Created a script to generate the documentation for pydocs to be checked
into the beam site.
- Added sphinx as a dev dependency
- There will be a corresponding PR in the beam-site repo
---
Be sure to do all of the following to help us incorporate your contribution
quickly and easily:
- [ ] Make sure the PR title is formatted like:
`[BEAM-<Jira issue #>] Description of pull request`
- [ ] Make sure tests pass via `mvn clean verify`. (Even better, enable
Travis-CI on your fork and ensure the whole test matrix passes).
- [ ] Replace `<Jira issue #>` in the title with the actual Jira issue
number, if there is one.
- [ ] If this contribution is large, please file an Apache
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.txt).
---
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/sb2nov/beam BEAM-1320-add-sphinx-documentation
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/beam/pull/2024.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 #2024
----
commit 7f6a239edfa56a485b2f623cc2e4fce17a220f96
Author: Sourabh Bajaj <[email protected]>
Date: 2017-02-16T22:49:56Z
[BEAM-1320] Add script to generate documentation for the python sdk
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
