New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs with new template and documentation #2078

Merged
merged 3 commits into from Nov 7, 2018

Conversation

Projects
None yet
4 participants
@akmorrow13
Copy link
Contributor

akmorrow13 commented Nov 6, 2018

  • switches to default docs template
  • adds autosummary documentation for python
@coveralls

This comment has been minimized.

Copy link

coveralls commented Nov 6, 2018

Coverage Status

Coverage remained the same at 79.206% when pulling b13549b on akmorrow13:update-docs into fc67969 on bigdatagenomics:master.

@AmplabJenkins

This comment has been minimized.

Copy link

AmplabJenkins commented Nov 6, 2018

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/ADAM-prb/2851/
Test PASSed.

@heuermh
Copy link
Member

heuermh left a comment

Awesome, thanks for doing this! Found a few minor typos

def toDF(self):
"""
Converts this GenomicDatset into a dataframeself.

This comment has been minimized.

@heuermh

heuermh Nov 6, 2018

Member

dataframeself → dataframe.


class VariantContextRDD(VCFSupportingGenomicDataset):
"""
Wraps an GenomicDatset with Alignment Context metadata and functions.

This comment has been minimized.

@heuermh

heuermh Nov 6, 2018

Member

GenomicDatset → GenomicDataset

This comment has been minimized.

@heuermh

heuermh Nov 6, 2018

Member

Alignment Context → Variant Context

@heuermh heuermh added this to the 0.25.0 milestone Nov 6, 2018

@akmorrow13 akmorrow13 force-pushed the akmorrow13:update-docs branch from ae0f124 to b13549b Nov 6, 2018

@AmplabJenkins

This comment has been minimized.

Copy link

AmplabJenkins commented Nov 6, 2018

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/ADAM-prb/2852/
Test PASSed.

@heuermh

This comment has been minimized.

Copy link
Member

heuermh commented Nov 6, 2018

@akmorrow13 Ping me when this is ready to merge

@akmorrow13

This comment has been minimized.

Copy link
Contributor

akmorrow13 commented Nov 7, 2018

@heuermh I fixed the comments it is ready for merge. I tested locally with sphinx but it is always hard to tell for sure whether readthedocs will run.

@heuermh

This comment has been minimized.

Copy link
Member

heuermh commented Nov 7, 2018

Same here (with sphinx), let's give it a try.

@heuermh heuermh merged commit 032ab3b into bigdatagenomics:master Nov 7, 2018

1 check passed

default Merged build finished.
Details
@heuermh

This comment has been minimized.

Copy link
Member

heuermh commented Nov 7, 2018

Thank you, @akmorrow13!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment