[HLS-360] Get readthedocs to work #3

karenfeng · 2019-10-10T14:04:41Z

What changes are proposed in this pull request?

Turns out that readthedocs does not play nice with the static links Databricks uses to refer to notebooks. The base-layer HTML served by readthedocs refers to <glow-url>/<language>/<version>, so we have to use relative URLs.

How is this patch tested?

Unit tests
Integration tests
Manual tests

https://project-glow-glow.readthedocs-hosted.com/en/rtd-work/api/sample-qc.html#sample-qc-demo

kianfar77

Looks good.

# This is the 1st commit message: WIP # This is the commit message projectglow#2: Get jar working Don't use Kryo serializer Don't parallelize un-serializable Hadoop FileStatus Change descrip WIP Whoops bintray Not local Quiet logs Remove tmp file Actually rename bintray Setting version to 0.1.0 WIP WIP License fixup Resolver WIP Change version Setting version to 0.1.1 WIP Setting version to 0.1.2 Setting version to 0.1.3-SNAPSHOT WIP Setting version to 0.1.2 Setting version to 0.1.3-SNAPSHOT Exclude many GATK deps Setting version to 0.1.3 Setting version to 0.1.4-SNAPSHOT Setting version to 0.1.4 Setting version to 0.1.5-SNAPSHOT Whoops Setting version to 0.1.3 Setting version to 0.1.4-SNAPSHOT Setting version to 0.1.4 Setting version to 0.1.5-SNAPSHOT Setting version to 0.1.6 Setting version to 0.1.7-SNAPSHOT Yay deps Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.1 Setting version to 0.1.2-SNAPSHOT Setting version to 0.1.10 Setting version to 0.1.11-SNAPSHOT Setting version to 0.1.15 Setting version to 0.1.16-SNAPSHOT Setting version to 0.1.9 Setting version to 0.1.10-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Add tests back Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.13 Setting version to 0.1.14-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT WIP Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.11 Setting version to 0.1.12-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Exclude findbugs Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT WIP Cleanup # This is the commit message projectglow#3: Rename org # This is the commit message projectglow#4: Rename env # This is the commit message projectglow#5: Setting version to 0.1.0 # This is the commit message projectglow#6: Setting version to 0.1.1-SNAPSHOT # This is the commit message projectglow#7: Rename # This is the commit message projectglow#8: Work on test.pypi # This is the commit message projectglow#9: Fix VCFFileWriterSuite (projectglow#63) # This is the commit message projectglow#10: Remove SpecificInternalRow buffer in RowConverter (projectglow#65) * Remove SpecificInternalRow buffer in RowConverter * comment

# This is the 1st commit message: WIP # This is the commit message projectglow#2: Get jar working Don't use Kryo serializer Don't parallelize un-serializable Hadoop FileStatus Change descrip WIP Whoops bintray Not local Quiet logs Remove tmp file Actually rename bintray Setting version to 0.1.0 WIP WIP License fixup Resolver WIP Change version Setting version to 0.1.1 WIP Setting version to 0.1.2 Setting version to 0.1.3-SNAPSHOT WIP Setting version to 0.1.2 Setting version to 0.1.3-SNAPSHOT Exclude many GATK deps Setting version to 0.1.3 Setting version to 0.1.4-SNAPSHOT Setting version to 0.1.4 Setting version to 0.1.5-SNAPSHOT Whoops Setting version to 0.1.3 Setting version to 0.1.4-SNAPSHOT Setting version to 0.1.4 Setting version to 0.1.5-SNAPSHOT Setting version to 0.1.6 Setting version to 0.1.7-SNAPSHOT Yay deps Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.1 Setting version to 0.1.2-SNAPSHOT Setting version to 0.1.10 Setting version to 0.1.11-SNAPSHOT Setting version to 0.1.15 Setting version to 0.1.16-SNAPSHOT Setting version to 0.1.9 Setting version to 0.1.10-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Add tests back Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.13 Setting version to 0.1.14-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT WIP Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.11 Setting version to 0.1.12-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Exclude findbugs Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT WIP Cleanup # This is the commit message projectglow#3: Rename org # This is the commit message projectglow#4: Rename env # This is the commit message projectglow#5: Setting version to 0.1.0 # This is the commit message projectglow#6: Setting version to 0.1.1-SNAPSHOT # This is the commit message projectglow#7: Rename # This is the commit message projectglow#8: Work on test.pypi # This is the commit message projectglow#9: Fix VCFFileWriterSuite (projectglow#63) # This is the commit message projectglow#10: Remove SpecificInternalRow buffer in RowConverter (projectglow#65) * Remove SpecificInternalRow buffer in RowConverter * comment # This is the commit message projectglow#11: Update CircleCI badge # This is the commit message projectglow#12: Move build/test from README to wiki # This is the commit message projectglow#13: More cleanup # This is the commit message projectglow#14: Newline # This is the commit message projectglow#15: address comments # This is the commit message projectglow#16: Circleci fixups # This is the commit message projectglow#17: Un-exclude netlib from gatk # This is the commit message projectglow#18: CircleCI indents # This is the commit message projectglow#19: Change bintray org # This is the commit message projectglow#20: Setting version to 0.1.0 # This is the commit message projectglow#21: Bintray repo # This is the commit message projectglow#22: Move bintrayrepo # This is the commit message projectglow#23: Setting version to 0.1.1-SNAPSHOT

Get jar working Don't use Kryo serializer Don't parallelize un-serializable Hadoop FileStatus Change descrip WIP Whoops bintray Not local Quiet logs Remove tmp file Actually rename bintray Setting version to 0.1.0 WIP WIP License fixup Resolver WIP Change version Setting version to 0.1.1 WIP Setting version to 0.1.2 Setting version to 0.1.3-SNAPSHOT WIP Setting version to 0.1.2 Setting version to 0.1.3-SNAPSHOT Exclude many GATK deps Setting version to 0.1.3 Setting version to 0.1.4-SNAPSHOT Setting version to 0.1.4 Setting version to 0.1.5-SNAPSHOT Whoops Setting version to 0.1.3 Setting version to 0.1.4-SNAPSHOT Setting version to 0.1.4 Setting version to 0.1.5-SNAPSHOT Setting version to 0.1.6 Setting version to 0.1.7-SNAPSHOT Yay deps Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.1 Setting version to 0.1.2-SNAPSHOT Setting version to 0.1.10 Setting version to 0.1.11-SNAPSHOT Setting version to 0.1.15 Setting version to 0.1.16-SNAPSHOT Setting version to 0.1.9 Setting version to 0.1.10-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Add tests back Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Setting version to 0.1.13 Setting version to 0.1.14-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT WIP Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT WIP Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT Setting version to 0.1.11 Setting version to 0.1.12-SNAPSHOT Setting version to 0.1.7 Setting version to 0.1.8-SNAPSHOT Exclude findbugs Setting version to 0.1.8 Setting version to 0.1.9-SNAPSHOT WIP Cleanup Rename org Rename env Setting version to 0.1.0 Setting version to 0.1.1-SNAPSHOT Rename Work on test.pypi Fix VCFFileWriterSuite (projectglow#63) Remove SpecificInternalRow buffer in RowConverter (projectglow#65) * Remove SpecificInternalRow buffer in RowConverter * comment Update CircleCI badge Move build/test from README to wiki More cleanup Newline address comments Circleci fixups Un-exclude netlib from gatk CircleCI indents Change bintray org Setting version to 0.1.0 Bintray repo Move bintrayrepo Setting version to 0.1.1-SNAPSHOT Rename everything to glow (projectglow#2) * do the big rename * Make tests pass * imports * sg -> glow * Trigger CircleCI tests * Trigger CircleCI again * Fix CircleCI config * Fix Python dir * Rename datasources * CircleCI wip * More CircleCI wip * Continue Circleci wip * WIP * Revert last change * Un package-private * More un package-private * Continue un package-private * More un-package-private * Try again * no core * rename * compile * fix test * fix tests * test file * no tabs * less logging' * update * io * ignore unit tests Whoops [HLS-360] Get readthedocs to work (projectglow#3) * Notebooks in docs subfolder * WIP * WIP * WIP * WIP * WIP * Un-raw * WIP * WIP * WIP * WIP * WIP * WIP * WIP * More WIP * Try again * Remove unneeded imports Make Glow a class with extending object (projectglow#5) Fix Glow tests (projectglow#6) * oops * fix pipe transformer cleanup Update log4j.properties Add license header (projectglow#9) add CONTIBURING.md (projectglow#10) Signed-off-by: Henry D <henrydavidge@gmail.com>

* Notebooks in docs subfolder * WIP * WIP * WIP * WIP * WIP * Un-raw * WIP * WIP * WIP * WIP * WIP * WIP * WIP * More WIP * Try again * Remove unneeded imports Signed-off-by: Karen Feng <karen.feng@databricks.com>

Add Leland's demo notebook

* Add scalastyle to build * add fiel Signed-off-by: Henry Davidge <hhd@databricks.com>

* Notebooks in docs subfolder * WIP * WIP * WIP * WIP * WIP * Un-raw * WIP * WIP * WIP * WIP * WIP * WIP * WIP * More WIP * Try again * Remove unneeded imports Signed-off-by: Henry Davidge <hhd@databricks.com>

Add Leland's demo notebook Signed-off-by: Henry Davidge <hhd@databricks.com>

karenfeng added 16 commits October 10, 2019 11:53

Notebooks in docs subfolder

8ea5a0c

WIP

0bb098a

WIP

33499f6

WIP

8a570fc

WIP

43c5dbc

WIP

79c15ba

Un-raw

7131d94

WIP

b7c1518

WIP

aa8f74a

WIP

d527072

WIP

5dcd941

WIP

a601c6c

WIP

99bf6e9

WIP

c6798af

More WIP

a93d185

Try again

01b61af

karenfeng requested a review from henrydavidge October 10, 2019 14:04

Remove unneeded imports

5254e75

karenfeng changed the title ~~Get readthedocs to work~~ [HLS-360] Get readthedocs to work Oct 10, 2019

kianfar77 approved these changes Oct 10, 2019

View reviewed changes

karenfeng merged commit 2df33ad into master Oct 10, 2019

karenfeng deleted the rtd-work branch October 10, 2019 21:54

henrydavidge added a commit to henrydavidge/glow that referenced this pull request Jun 22, 2020

Merge pull request projectglow#3 from henrydavidge/add-nb

1955d38

Add Leland's demo notebook

henrydavidge added a commit to henrydavidge/glow that referenced this pull request Jun 22, 2020

Add scalastyle to build (projectglow#3)

f7ea696

* Add scalastyle to build * add fiel Signed-off-by: Henry Davidge <hhd@databricks.com>

henrydavidge added a commit to henrydavidge/glow that referenced this pull request Jun 22, 2020

Merge pull request projectglow#3 from henrydavidge/add-nb

28b5d82

Add Leland's demo notebook Signed-off-by: Henry Davidge <hhd@databricks.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[HLS-360] Get readthedocs to work #3

[HLS-360] Get readthedocs to work #3

Uh oh!

karenfeng commented Oct 10, 2019 •

edited

Loading

Uh oh!

kianfar77 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[HLS-360] Get readthedocs to work #3

[HLS-360] Get readthedocs to work #3

Uh oh!

Conversation

karenfeng commented Oct 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes are proposed in this pull request?

How is this patch tested?

Uh oh!

kianfar77 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

karenfeng commented Oct 10, 2019 •

edited

Loading