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.

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

DOC simplify the readme #91

Merged
merged 7 commits into from Apr 21, 2018
Merged

Conversation

rth
Copy link
Contributor

@rth rth commented Mar 28, 2018

This PR aims to simplify the readme, and improve linking to the documentation for the v1.4 release (#67). In particular, redundant examples are removed instead pointing to the example gallery.

The updated version can be viewed in https://github.com/rth/PyKrige/blob/simplify-readme/README.rst

Please let me know what you think.

@rth rth added this to the v1.4 milestone Mar 28, 2018

.. code:: bash

pip install --upgrade pykrige
Copy link
Contributor Author

@rth rth Mar 28, 2018

Choose a reason for hiding this comment

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

pip prior to mid 2017 by default has an eager upgrade strategy pypa/pip@375ed4d that can break things in the existing packages pypa/pip#304 so I'd rather not put this in the readme.

@bsmurphy
Copy link
Contributor

I'd prefer to keep the UK and 3D examples since they demonstrate slightly different things than just regular OK. Can we stick those over in the examples? You (or I) can just copy-paste the UK and 3D example codes into new files, maybe add a plot (if you feel like it).

@rth
Copy link
Contributor Author

rth commented Apr 19, 2018

Sorry for the delay @bsmurphy . I added back the examples (that can also be found in http://pykrige.readthedocs.io/en/latest/examples/index.html).

@rth
Copy link
Contributor Author

rth commented Apr 21, 2018

Also updated the long description to contain the full readme and updated appveyor.

Merging, @bsmurphy please edit the readme on master if there are changes you are not enthousiastic about. Links to the stable docs are not working yet, it's necessary to create a git tag for readthedocs to generate a link to it (working on it)

@rth rth merged commit c58eabd into GeoStat-Framework:master Apr 21, 2018
@rth rth deleted the simplify-readme branch April 21, 2018 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants