Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
busunkim96 committed Oct 21, 2019
1 parent ec918fb commit 820fb9b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 11 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Here are some guidelines for hacking on ``google-auth-library-python``.
Making changes
--------------

A few notes on making changes to ``google-auth-libary-python``.
A few notes on making changes to ``google-auth-library-python``.

- If you've added a new feature or modified an existing feature, be sure to
add or update any applicable documentation in docstrings and in the
Expand All @@ -37,11 +37,11 @@ Running system tests

You can run the system tests with ``nox``::

$ nox -s system
$ nox -f system_tests/noxfile.py

To run a single session, specify it with ``nox -s``::

$ nox -s service_account
$ nox -f system_tests/noxfile.py -s service_account

To run system tests locally, you will need to set up a data directory.

Expand Down Expand Up @@ -78,7 +78,7 @@ From ``system_tests/app_engine_test_app`` run the following commands.
After the app is deployed, change ``service`` in ``app.yaml`` back to ``google-auth-system-tests``.
You can now run the App Engine tests:

$ nox -s app_engine
$ nox -f system_tests/noxfile.py -s app_engine

Coding Style
------------
Expand Down
6 changes: 0 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,10 @@ Google Auth Python Library
This library simplifies using Google's various server-to-server authentication
mechanisms to access Google APIs.

.. |build| image:: https://travis-ci.org/GoogleCloudPlatform/google-auth-library-python.svg?branch=master
:target: https://travis-ci.org/GoogleCloudPlatform/google-auth-library-python
.. |docs| image:: https://readthedocs.org/projects/google-auth/badge/?version=latest
:target: https://google-auth.readthedocs.io/en/latest/
.. |pypi| image:: https://img.shields.io/pypi/v/google-auth.svg
:target: https://pypi.python.org/pypi/google-auth
.. |compat_check_pypi| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=google-auth
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=google-auth
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-auth-library-python.git
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-auth-library-python.git

Installing
----------
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@
intersphinx_mapping = {
'python': ('https://docs.python.org/3.5', None),
'urllib3': ('https://urllib3.readthedocs.io/en/stable', None),
'requests': ('http://docs.python-requests.org/en/stable', None),
'requests': ('https://requests.kennethreitz.org/en/master/', None),
'requests-oauthlib': (
'http://requests-oauthlib.readthedocs.io/en/stable', None),
}
Expand Down

0 comments on commit 820fb9b

Please sign in to comment.