From 084664bba8922441ff854d2c84df3caafd9d05a4 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Fri, 7 Aug 2015 11:41:14 -0700 Subject: [PATCH] Moving CONTRIBUTING out of docs to repository top-level. --- docs/contributing.rst => CONTRIBUTING.rst | 0 README.md | 21 +++++++++++---------- docs/index.rst | 5 +++-- 3 files changed, 14 insertions(+), 12 deletions(-) rename docs/contributing.rst => CONTRIBUTING.rst (100%) diff --git a/docs/contributing.rst b/CONTRIBUTING.rst similarity index 100% rename from docs/contributing.rst rename to CONTRIBUTING.rst diff --git a/README.md b/README.md index cd7632894..d1fc5d0e2 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,29 @@ [![Build Status](https://travis-ci.org/google/oauth2client.svg?branch=master)](https://travis-ci.org/google/oauth2client) - [![Coverage Status](https://img.shields.io/coveralls/google/oauth2client.svg)](https://coveralls.io/r/google/oauth2client?branch=master) +[![Documentation Status](https://readthedocs.org/projects/oauth2client/badge/?version=latest)](http://oauth2client.readthedocs.org/) This is a client library for accessing resources protected by OAuth 2.0. -[Full documentation](http://google.github.io/oauth2client/) - Installation ============ To install, simply say - $ pip install --upgrade oauth2client +```bash +$ pip install --upgrade oauth2client +``` Contributing ============ -Please see the -[contributing page](http://google.github.io/oauth2client/contributing.html) -for more information. In particular, we love pull requests -- but please make -sure to sign the contributor license agreement. +Please see the [CONTRIBUTING page][1] for more information. In particular, we +love pull requests -- but please make sure to sign the contributor license +agreement. Supported Python Versions ========================= -We support Python 2.6, 2.7, 3.3+. More information -[in the docs](http://google.github.io/oauth2client/#supported-python-versions). +We support Python 2.6, 2.7, 3.3+. More information [in the docs][2]. + +[1]: https://github.com/google/oauth2client/blob/master/CONTRIBUTING.rst +[2]: http://oauth2client.readthedocs.org/#supported-python-versions diff --git a/docs/index.rst b/docs/index.rst index a000d4110..cf342a320 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,16 +40,17 @@ Library Documentation Contributing ------------ -Please see the `contributing page `_ for more information. +Please see the `contributing page`_ for more information. In particular, we love pull requests -- but please make sure to sign the contributor license agreement. +.. _contributing page: https://github.com/google/oauth2client/blob/master/CONTRIBUTING.rst + .. toctree:: :maxdepth: 1 :hidden: source/modules - contributing Supported Python Versions -------------------------