Skip to content
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.

Sign up for GitHub

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

Jump to bottom

DOC: Add new backends and Geospatial methods to documentation #2034

Merged
merged 1 commit into from
Jan 20, 2020
Merged

DOC: Add new backends and Geospatial methods to documentation #2034

merged 1 commit into from
Jan 20, 2020

Conversation

xmnlab
Copy link
Contributor

@xmnlab xmnlab commented Nov 18, 2019 •
edited by jreback
Loading

In this PR:

  • Added initial documentation for OmniSciDB, MySQL, PySpark and SparkSQL backends
  • Added initial documentation for Geo Spatial methods
  • Added link to Ibis wiki page
  • Fixed PySpark and Spark connect docstring: **kwargs needed to be escaped.
    xref partially Documentation improvements #2025

ian-r-rose
ian-r-rose reviewed Nov 18, 2019
View reviewed changes
@xmnlab xmnlab changed the title DOC: Add new backends and Geo Spatial documentation DOC: Add new backends and Geospatial methods to documentation Nov 18, 2019
@xmnlab xmnlab marked this pull request as ready for review November 20, 2019 00:21
@xmnlab xmnlab requested review from jreback and scottcode November 20, 2019 00:21
@xmnlab
Copy link
Contributor Author

xmnlab commented Nov 20, 2019

it is done for review! :)

@xmnlab xmnlab mentioned this pull request Nov 25, 2019
Closed
@xmnlab xmnlab force-pushed the improve-docs branch 2 times, most recently from 88facd8 to 7441683 Compare December 6, 2019 02:46
@xmnlab
Copy link
Contributor Author

xmnlab commented Dec 6, 2019

@scottcode @jreback could you please review this PR? thanks!

@jreback jreback added docs Documentation related issues or PRs omnisci labels Dec 6, 2019
@jreback jreback added this to the Next Feature Release milestone Dec 6, 2019
jreback
jreback suggested changes Dec 6, 2019
View reviewed changes
docs/source/backends.rst Outdated

TODO
- PostgreSQL
- SQLite
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@xmnlab
Copy link
Contributor Author

xmnlab commented Dec 8, 2019

@jreback thanks for the review. I already applied the suggestion you made. thanks!

@xmnlab
Copy link
Contributor Author

xmnlab commented Dec 12, 2019

@jreback any more thought about this PR? let me know and if it is OK .. I will rebase to fix the conflict on release.rst

@xmnlab
Copy link
Contributor Author

xmnlab commented Jan 7, 2020

@jreback any more thought about this PR? let me know and if it is OK .. I will rebase to fix the conflict on release.rst

@jreback
Copy link
Contributor

jreback commented Jan 9, 2020

looks good @xmnlab yeah go ahead and rebase. will look at the built link then.

@xmnlab
Copy link
Contributor Author

xmnlab commented Jan 9, 2020

rebased and CI status green :)
thanks @jreback

@xmnlab
Copy link
Contributor Author

xmnlab commented Jan 13, 2020

@jreback a gentle reminder about this PR :)

@jreback
Copy link
Contributor

jreback commented Jan 14, 2020

IIRC there was a way to look at the build docs, @xmnlab can you see if there are any docs around about this?

@xmnlab
Copy link
Contributor Author

xmnlab commented Jan 14, 2020

@jreback ok I will check that today!

@xmnlab
Copy link
Contributor Author

xmnlab commented Jan 14, 2020

As I could understand ... it currently uses github pages to serve the documentation and files are pushed to that repo just after merging (as you can see here, the publish step is skipped https://dev.azure.com/ibis-project/ibis/_build/results?buildId=1749&view=logs&jobId=6a991cd6-976c-5315-84e1-201ee118e969&j=8f09edc2-e3b7-52de-126a-0225c4f3efa1&t=821d7798-77bc-5c2b-d93a-439a2b545f54).

Currently, if you want to check the built docs you need to build it locally

let me know if I am missing anything ..

@xmnlab
Copy link
Contributor Author

xmnlab commented Jan 20, 2020

hey @jreback ! is there anything else I can do for this PR? or could it be merged? thanks!

jreback
jreback approved these changes Jan 20, 2020
View reviewed changes
Copy link
Contributor

@jreback jreback left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @xmnlab

pls review the published docs for accuracy.

@jreback jreback merged commit dfde59e into ibis-project:master Jan 20, 2020
@xmnlab xmnlab deleted the improve-docs branch January 21, 2020 02:03
@xmnlab
Copy link
Contributor Author

xmnlab commented Jan 21, 2020

@jreback it seems docs is working properly. thanks!

@anmyachev anmyachev mentioned this pull request Feb 11, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ian-r-rose ian-r-rose ian-r-rose left review comments

@jreback jreback jreback approved these changes

@scottcode scottcode Awaiting requested review from scottcode

Assignees

@jreback jreback

Labels
docs Documentation related issues or PRs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xmnlab @jreback @ian-r-rose