Started using sphinx for documentation

Set up sphinx project in docs/, added some documentation to LinodeClient
class

Author: Dorthu

.gitignore

@@ -4,3 +4,4 @@ build
 dist
 *.egg-info
 .eggs/*
+docs/_build/*

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = linode-api
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,168 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'linode-api'
+copyright = '2018, Linode'
+author = 'Linode'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '4.1.8b1'
+
+
+# -- 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.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+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'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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 = '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 = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'linode-apidoc'
+
+
+# -- 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',
+}
+
+# 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, 'linode-api.tex', 'linode-api Documentation',
+     'Linode', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'linode-api', 'linode-api Documentation',
+     [author], 1)
+]
+
+
+# -- 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 = [
+    (master_doc, 'linode-api', 'linode-api Documentation',
+     author, 'linode-api', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

docs/core_concepts.rst

@@ -0,0 +1,4 @@
+Core Concepts
+=============
+
+TODO

docs/getting_started.rst

@@ -0,0 +1,112 @@
+Getting Started
+===============
+
+Installation
+------------
+
+The linode-api package can be installed from pypi as shown:
+
+.. code-block:: shell
+
+   pip install linode-api
+
+If you prefer, you can clone the package from github_ and install it from source:
+
+.. _github: https://github.com/Linode/python-linode-api
+
+.. code-block:: shell
+
+   git clone git@github.com:Linode/python-linode-api
+   cd python-linode-api
+   python setup.py install
+
+.. note::
+   This library uses the "linode" namespace.  This could conflict with other
+   libraries intended to interact with older versions of the Linode API.  If
+   you depend on a python library to interact with older versions of the Linode
+   API, consider using a virtualenv when installing this library.
+
+Authentication
+--------------
+
+In order to make requests to the Linode API, you will need a token.  To generate
+one,  log in to cloud.linode.com_, and on your profile_ click "Create a Personal
+Access Token".
+
+.. _cloud.linode.com: https://cloud.linode.com
+.. _profile: https://cloud.linode.com/profile/tokens
+
+.. note::
+   You can also use an OAuth Token to authenticate to the API - see OAuth_
+   for details.
+
+.. _OAuth: #
+
+When creating a Personal Access Token, you will be prompted for what scopes the
+token should be created with.  These scopes control what parts of your account
+this token may be used to access - for more information, see `OAuth Scopes`_.
+Restricting what a token can access is more secure than creating one with access
+to your entire account, but can be less convenient since you would need to create
+a new token to access other parts of the account.  For the examples on this page,
+your Personal Access Token must be able to view and create Linodes.
+
+.. _OAuth Scopes: #
+
+Listing your Linodes
+--------------------
+
+Using the token you generated above, create a :py:class:`LinodeClient` object
+that will be used for all interactions with the API.
+
+.. code-block:: python
+
+   from linode import LinodeClient
+   client = LinodeClient(token)
+
+This object will manage all requests you make through the API.  Now that it's
+set up, you can use it to retrieve and print a list of your Linodes:
+
+.. code-block:: python
+
+   my_linodes = client.linode.get_instances()
+
+   for current_linode in my_linodes:
+       print(current_linode.label)
+
+When retrieving collections of objects from the API, a list-like object is
+returned, and may be iterated over or indexed as a normal list.G
+
+Creating a Linode
+-----------------
+
+In order to create a Linode, we need a few pieces of information: what
+:py:class:Region to create the Linode in, what :py:class:Type of Linode to
+create, and what :py:class:Image to deploy to the new Linode.  We can query
+for these values similarly to how we listed our Linodes above:
+
+.. code-block:: python
+
+   available_regions = client.get_regions()
+
+We could also use values that we know in advance to avoid the need to query the
+API - for example, we may know that we want a `g5-standard-4` Linode running the
+`linode/debian9` Image.  Both objects and IDs are accepted when creating a Linode.
+
+.. code-block:: python
+
+   chosen_region = available_regions[0]
+
+   new_linode, password = client.linode.create_instance(chosen_region,
+                                                        'g5-standard-4',
+                                                        image='linode/debian9')
+
+:py:func:`create_instance` returns the newly-created Linode object and the
+root password that was generated for it.  This Linode will boot automatically,
+and should be available shortly.  Finally, let's print out the results so we
+can access our new server.
+
+.. code-block:: python
+
+   print("ssh root@{} - {}".format(new_linode.ipv4[0], password))
+
+Continue on to `Core Concepts <core_concepts.html>`_

docs/index.rst

@@ -0,0 +1,24 @@
+.. linode-api documentation master file, created by
+   sphinx-quickstart on Sat Mar 10 11:37:03 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+linode-api
+==========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting_started
+   core_concepts
+   linode_client
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

docs/linode_client.rst

@@ -0,0 +1,10 @@
+Linode Client
+=============
+
+.. module:: linode
+
+.. autoclass:: LinodeClient
+   :members:
+
+.. autoclass:: linode.linode_client.LinodeGroup
+   :members: