docs: update docs

googleapis · Oct 22, 2019 · c4b4f77 · c4b4f77
1 parent 1383419
commit c4b4f77
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 72 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -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
@@ -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.
 
@@ -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
 ------------

diff --git a/README.rst b/README.rst
@@ -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
 ----------

diff --git a/docs/conf.py b/docs/conf.py
@@ -33,40 +33,40 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.viewcode",
-    "sphinx.ext.napoleon",
-    "sphinx_docstring_typing",
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    'sphinx_docstring_typing'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
+source_suffix = '.rst'
 
 # The encoding of source files.
 #
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = "index"
+master_doc = 'index'
 
 # General information about the project.
-project = "google-auth"
-copyright = "2016, Google, Inc."
-author = "Google, Inc."
+project = 'google-auth'
+copyright = '2016, Google, Inc.'
+author = 'Google, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = pkg_resources.get_distribution("google-auth").version
+version = pkg_resources.get_distribution('google-auth').version
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -89,7 +89,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -111,7 +111,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
+pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -128,21 +128,21 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 html_theme_options = {
-    "description": "Google Auth Library for Python",
-    "github_user": "GoogleCloudPlatform",
-    "github_repo": "google-auth-library-python",
-    "github_banner": True,
-    "travis_button": True,
-    "font_family": "'Roboto', Georgia, sans",
-    "head_font_family": "'Roboto', Georgia, serif",
-    "code_font_family": "'Roboto Mono', 'Consolas', monospace",
+    'description': 'Google Auth Library for Python',
+    'github_user': 'GoogleCloudPlatform',
+    'github_repo': 'google-auth-library-python',
+    'github_banner': True,
+    'travis_button': True,
+    'font_family': "'Roboto', Georgia, sans",
+    'head_font_family': "'Roboto', Georgia, serif",
+    'code_font_family': "'Roboto Mono', 'Consolas', monospace",
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -171,7 +171,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -194,7 +194,12 @@
 #
 
 html_sidebars = {
-    "**": ["about.html", "navigation.html", "relations.html", "searchbox.html"]
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+    ]
 }
 
 # Additional templates that should be rendered to pages, maps page names to
@@ -254,36 +259,34 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "google-authdoc"
+htmlhelp_basename = 'google-authdoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
+     # The paper size ('letterpaper' or 'a4paper').
+     #
+     # 'papersize': 'letterpaper',
+
+     # The font size ('10pt', '11pt' or '12pt').
+     #
+     # 'pointsize': '10pt',
+
+     # Additional stuff for the LaTeX preamble.
+     #
+     # 'preamble': '',
+
+     # Latex figure (float) alignment
+     #
+     # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (
-        master_doc,
-        "google-auth.tex",
-        "google-auth Documentation",
-        "Google, Inc.",
-        "manual",
-    )
+    (master_doc, 'google-auth.tex', 'google-auth Documentation',
+     'Google, Inc.', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -323,7 +326,10 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "google-auth", "google-auth Documentation", [author], 1)]
+man_pages = [
+    (master_doc, 'google-auth', 'google-auth Documentation',
+     [author], 1)
+]
 
 # If true, show URL addresses after external links.
 #
@@ -336,15 +342,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (
-        master_doc,
-        "google-auth",
-        "google-auth Documentation",
-        author,
-        "google-auth",
-        "One line description of project.",
-        "Miscellaneous",
-    )
+    (master_doc, 'google-auth', 'google-auth Documentation',
+     author, 'google-auth', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -366,13 +366,14 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 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-oauthlib": ("http://requests-oauthlib.readthedocs.io/en/stable", None),
+    'python': ('https://docs.python.org/3.5', None),
+    'urllib3': ('https://urllib3.readthedocs.io/en/stable', None),
+    'requests': ('https://requests.kennethreitz.org/en/master/', None),
+    'requests-oauthlib': (
+        'http://requests-oauthlib.readthedocs.io/en/stable', None),
 }
 
 # Autodoc config
-autoclass_content = "both"
-autodoc_member_order = "bysource"
-autodoc_mock_imports = ["grpc"]
+autoclass_content = 'both'
+autodoc_member_order = 'bysource'
+autodoc_mock_imports = ['grpc']