Merge pull request #549 from jamiehannaford/rst-conversion

Migrate docs to RST

Author: ycombinator

doc/.gitignore

@@ -0,0 +1 @@
+_build/

doc/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/php-opencloud.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/php-opencloud.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/php-opencloud"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/php-opencloud"
+	@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."

doc/caching-creds.rst

@@ -0,0 +1,44 @@
+Caching credentials
+===================
+
+You can speed up your API operations by caching your credentials in a
+(semi-)permanent location, such as your DB or local filesystem. This
+enable subsequent requests to access a shared resource, instead of
+repetitively having to re-authenticate on every thread of execution.
+
+Tokens are valid for 24 hours, so you can effectively re-use the same
+cached value for that period. If you try to use a cached version that
+has expired, an authentication request will be made.
+
+Filesystem example
+------------------
+
+In this example, credentials will be saved to a file in the local
+filesystem. Be sure to exclude it from your VCS.
+
+.. code-block:: php
+
+  use OpenCloud\Rackspace;
+
+  $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array(
+      'username' => 'foo',
+      'apiKey'   => 'bar'
+  ));
+
+  $cacheFile = __DIR__ . '/.opencloud_token';
+
+  // If the cache file exists, try importing it into the client
+  if (file_exists($cacheFile)) {
+      $data = unserialize(file_get_contents($cacheFile));
+      $client->importCredentials($data);
+  }
+
+  $token = $client->getTokenObject();
+
+  // If no token exists, or the current token is expired, re-authenticate and save the new token to disk
+  if (!$token || ($token && $token->hasExpired())) {
+      $client->authenticate();
+      file_put_contents($cacheFile, serialize($client->exportCredentials()));
+  }
+
+In tests, the above code shaved about 1-2s off the execution time.

doc/conf.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+#
+# php-opencloud documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar  3 12:28:19 2015.
+#
+# 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
+from sphinx.highlighting import lexers
+from pygments.lexers.web import PhpLexer
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+lexers['php'] = PhpLexer(startinline=True, linenos=1)
+lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
+primary_domain = 'php'
+
+extensions = ['sphinxcontrib.phpdomain']
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+project = u'php-opencloud'
+copyright = u'2015, Jamie Hannaford, Shaunak Kashyap'
+version = '1.12'
+release = '1.12.1'
+exclude_patterns = ['_build']
+pygments_style = 'sphinx'
+html_theme = 'default'
+
+if not on_rtd:
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "_templates"]
+
+html_static_path = ['_static']
+html_use_index = True
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'php-openclouddoc'
+
+latex_documents = [
+  ('index', 'php-opencloud.tex', u'php-opencloud Documentation',
+   u'Jamie Hannaford, Shaunak Kashyap', 'manual'),
+]
+
+man_pages = [
+    ('index', 'php-opencloud', u'php-opencloud Documentation',
+     [u'Jamie Hannaford, Shaunak Kashyap'], 1)
+]
+
+texinfo_documents = [
+  ('index', 'php-opencloud', u'php-opencloud Documentation',
+   u'Jamie Hannaford, Shaunak Kashyap', 'php-opencloud', 'One line description of project.',
+   'Miscellaneous'),
+]

doc/debugging.rst

@@ -0,0 +1,103 @@
+Debugging
+=========
+
+There are two important debugging strategies to use when encountering
+problems with HTTP transactions.
+
+Strategy 1: Meaningful exception handling
+-----------------------------------------
+
+If the API returns a ``4xx`` or ``5xx`` status code, it indicates that
+there was an error with the sent request, meaning that the transaction
+cannot be adequately completed.
+
+The Guzzle HTTP component, which forms the basis of our SDK's transport
+layer, utilizes `numerous exception
+classes <https://github.com/guzzle/guzzle/tree/master/src/Guzzle/Http/Exception>`__
+to handle this error logic.
+
+The two most common exception classes are:
+
+-  ``Guzzle\Http\Exception\ClientErrorResponseException``, which is
+   thrown when a ``4xx`` response occurs
+
+-  ``Guzzle\Http\Exception\ServerErrorResponseException``, which is
+   thrown when a ``5xx`` response occurs
+
+Both of these classes extend the base ``BadResponseException`` class.
+
+This provides you with the granularity you need to debug and handle
+exceptions.
+
+An example with Swift
+~~~~~~~~~~~~~~~~~~~~~
+
+If you're trying to retrieve a Swift resource, such as a Data Object,
+and you're not completely certain that it exists, it makes sense to wrap
+your call in a try/catch block:
+
+.. code-block:: php
+
+  use Guzzle\Http\Exception\ClientErrorResponseException;
+
+  try {
+      return $service->getObject('foo.jpg');
+  } catch (ClientErrorResponseException $e) {
+      if ($e->getResponse()->getStatusCode() == 404) {
+        // Okay, the resource does not exist
+        return false;
+      }
+  } catch (\Exception $e) {
+      // Some other exception was thrown...
+  }
+
+
+Both ``ClientErrorResponseException`` and
+``ServerErrorResponseException`` have two methods that allow you to
+access the HTTP transaction:
+
+.. code-block:: php
+
+  // Find out the faulty request
+  $request = $e->getRequest();
+
+  // Display everything by casting as string
+  echo (string) $request;
+
+  // Find out the HTTP response
+  $response = $e->getResponse();
+
+  // Output that too
+  echo (string) $response;
+
+
+Strategy 2: Wire logging
+------------------------
+
+Guzzle provides a `Log
+plugin <http://docs.guzzlephp.org/en/latest/plugins/log-plugin.html>`__
+that allows you to log everything over the wire, which is useful if you
+don't know what's going on.
+
+Here's how you enable it:
+
+Install the plugin
+~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+  composer require guzzle/guzzle
+
+
+Add to your client
+~~~~~~~~~~~~~~~~~~
+
+.. code-block:: php
+
+  use Guzzle\Plugin\Log\LogPlugin;
+
+  $client->addSubscriber(LogPlugin::getDebugPlugin());
+
+
+The above will add a generic logging subscriber to your client, which
+will output every HTTP transaction to `STDOUT`.