diff options
| -rw-r--r-- | .gitignore | 4 | ||||
| -rw-r--r-- | docs/Makefile | 177 | ||||
| -rw-r--r-- | docs/_static/google_logo.png | bin | 0 -> 6322 bytes | |||
| -rw-r--r-- | docs/_templates/layout.html | 28 | ||||
| -rw-r--r-- | docs/conf.py | 272 | ||||
| -rw-r--r-- | docs/index.rst | 47 | ||||
| -rw-r--r-- | docs/source/modules.rst | 7 | ||||
| -rw-r--r-- | docs/source/oauth2client.rst | 134 |
8 files changed, 668 insertions, 1 deletions
@@ -3,7 +3,9 @@ oauth2client.egg-info/ build/ dist/ -docs/ + +# Built documentation +docs/_build # Test files .tox/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..46ca8ec --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make <target>' where <target> is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/oauth2client.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/oauth2client.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/oauth2client" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/oauth2client" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/_static/google_logo.png b/docs/_static/google_logo.png Binary files differnew file mode 100644 index 0000000..25fa00a --- /dev/null +++ b/docs/_static/google_logo.png diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 0000000..33920a5 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,28 @@ +{% extends "!layout.html" %} + +{# Custom CSS overrides #} +{# set bootswatch_css_custom = ['_static/my-styles.css'] #} + +{# Add github banner (from: https://github.com/codepo8/css-fork-on-github-ribbon). #} +{% block header %} + {{ super() }} + + <a href="https://github.com/google/oauth2client" + class="visible-desktop hidden-xs"> + <img id="gh-banner" + style="position:absolute; right:0; border:0; width:149px; height:149px;" + src="http://aral.github.com/fork-me-on-github-retina-ribbons/right-grey@2x.png" + alt="Fork me on GitHub"> + </a> + <script> + // Adjust banner height. + $(function () { + var navHeight = $(".navbar .container").css("height"); + $("#gh-banner").css("top", navHeight); + var navZ = $(".container").css("z-index"); + navZ = (navZ === "auto") ? 10 : navZ + 10; + $("#gh-banner").css("z-index", navZ); + }); + </script> +{% endblock %} + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..6c0bfc7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,272 @@ +# -*- coding: utf-8 -*- +# +# oauth2client documentation build configuration file, created by +# sphinx-quickstart on Wed Dec 17 23:13:19 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', + 'sphinxcontrib.napoleon', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'oauth2client' +copyright = u'2014, 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 = '1.4.4' +# The full version, including alpha/beta/rc tags. +release = '1.4.4' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# html_theme = 'default' + +import sphinx_bootstrap_theme + +html_logo = 'google_logo.png' +html_theme = 'bootstrap' +html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() +html_theme_options = { + 'bootswatch_theme': 'flatly', +} + +# 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 = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'oauth2clientdoc' + + +# -- 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': '', +} + +# 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 = [ + ('index', 'oauth2client.tex', u'oauth2client Documentation', + u'Google, Inc.', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'oauth2client', u'oauth2client Documentation', + [u'Google, Inc.'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'oauth2client', u'oauth2client Documentation', + u'Google, Inc.', 'oauth2client', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7ccd8e7 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,47 @@ +oauth2client +============ + +*making OAuth2 just a little less painful* + +``oauth2client`` makes it easy to interact with OAuth2-protected resources, +especially those related to Google APIs. You can also start with `general +information about using OAuth2 with Google APIs +<https://developers.google.com/accounts/docs/OAuth2>`_. + +Getting started +--------------- + +We recommend installing via ``pip``:: + + $ pip install --upgrade oauth2client + +You can also install from source:: + + $ git clone https://github.com/google/oauth2client + $ cd oauth2client + $ python setup.py install + +Downloads +^^^^^^^^^ + +* `Most recent release tarball + <https://github.com/google/oauth2client/tarball/master>`_ +* `Most recent release zipfile + <https://github.com/google/oauth2client/zipball/master>`_ +* `Complete release list <https://github.com/google/oauth2client/releases>`_ + +Library Documentation +--------------------- + +* Complete library index: :ref:`genindex` +* Index of all modules: :ref:`modindex` +* Search all documentation: :ref:`search` + +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. + diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..32a7349 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +oauth2client +============ + +.. toctree:: + :maxdepth: 4 + + oauth2client diff --git a/docs/source/oauth2client.rst b/docs/source/oauth2client.rst new file mode 100644 index 0000000..3888bd9 --- /dev/null +++ b/docs/source/oauth2client.rst @@ -0,0 +1,134 @@ +oauth2client package +==================== + +Submodules +---------- + +oauth2client.appengine module +----------------------------- + +.. automodule:: oauth2client.appengine + :members: + :undoc-members: + :show-inheritance: + +oauth2client.client module +-------------------------- + +.. automodule:: oauth2client.client + :members: + :undoc-members: + :show-inheritance: + +oauth2client.clientsecrets module +--------------------------------- + +.. automodule:: oauth2client.clientsecrets + :members: + :undoc-members: + :show-inheritance: + +oauth2client.crypt module +------------------------- + +.. automodule:: oauth2client.crypt + :members: + :undoc-members: + :show-inheritance: + +oauth2client.django_orm module +------------------------------ + +.. automodule:: oauth2client.django_orm + :members: + :undoc-members: + :show-inheritance: + +oauth2client.file module +------------------------ + +.. automodule:: oauth2client.file + :members: + :undoc-members: + :show-inheritance: + +oauth2client.gce module +----------------------- + +.. automodule:: oauth2client.gce + :members: + :undoc-members: + :show-inheritance: + +oauth2client.keyring_storage module +----------------------------------- + +.. automodule:: oauth2client.keyring_storage + :members: + :undoc-members: + :show-inheritance: + +oauth2client.locked_file module +------------------------------- + +.. automodule:: oauth2client.locked_file + :members: + :undoc-members: + :show-inheritance: + +oauth2client.multistore_file module +----------------------------------- + +.. automodule:: oauth2client.multistore_file + :members: + :undoc-members: + :show-inheritance: + +oauth2client.old_run module +--------------------------- + +.. automodule:: oauth2client.old_run + :members: + :undoc-members: + :show-inheritance: + +oauth2client.service_account module +----------------------------------- + +.. automodule:: oauth2client.service_account + :members: + :undoc-members: + :show-inheritance: + +oauth2client.tools module +------------------------- + +.. automodule:: oauth2client.tools + :members: + :undoc-members: + :show-inheritance: + +oauth2client.util module +------------------------ + +.. automodule:: oauth2client.util + :members: + :undoc-members: + :show-inheritance: + +oauth2client.xsrfutil module +---------------------------- + +.. automodule:: oauth2client.xsrfutil + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: oauth2client + :members: + :undoc-members: + :show-inheritance: |
