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

[Python] Simplify installation instructions #91

@bjwatson

Description

@bjwatson

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions