Skip to content
This repository has been archived by the owner on Jan 26, 2018. It is now read-only.

[Python] Simplify installation instructions #91

Open
bjwatson opened this issue Aug 17, 2016 · 0 comments
Open

[Python] Simplify installation instructions #91

bjwatson opened this issue Aug 17, 2016 · 0 comments
Labels

Comments

@bjwatson
Copy link
Contributor

bjwatson commented Aug 17, 2016

What:

Revise http://pythonhosted.org/gax-google-pubsub-v1/starting.html#installation as follows:

Installation
-----------

..code-block:: console

    pip install gax-google-pubsub-v1
It's recommended to use virtualenv(link).
For OS X / Linux::
    ...
For windows::
    ...

@jonparrott recommends the Request documentation as a good example.

Why:

In general, we should just show the simplest thing first (see https://googlecloudplatform.github.io/gcloud-python/stable/).

How:

This is controlled by either or both of:

  • templates/gax/python/README.rst.mustache
  • templates/gax/python/docs/starting.rst.mustache

Remove one of these if it's dead code.

@bjwatson bjwatson added the P3 label Aug 17, 2016
@bjwatson bjwatson changed the title Simplify Python installation instructions [Python] Simplify installation instructions Aug 18, 2016
@bjwatson bjwatson added P2 and removed P3 labels Aug 18, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

1 participant