Merge pull request #41 from BenjamenMeyer/enhancement_sphinx

Enhancement sphinx

docs/Makefile

@@ -0,0 +1,192 @@
+# 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 coverage 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 "  applehelp  to make an Apple Help Book"
+	@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)"
+	@echo "  coverage   to run coverage check of 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/Stack-In-A-Box.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Stack-In-A-Box.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Stack-In-A-Box"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Stack-In-A-Box"
+	@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."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.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."

docs/api/index.rst

@@ -0,0 +1,10 @@
+Class and Functions
+===================
+
+.. toctree::
+    :maxdepth: 2
+
+    stack
+    stack-exceptions
+    services/index
+    utils/index

docs/api/services/errors.rst

@@ -0,0 +1,20 @@
+.. _errors:
+
+StackInABoxService Errors
+=========================
+
+StackInABox has several specific HTTP Status Codes it returns to help in
+diagnosing issues.
+
++---------+-------------------------------------------------------------------------+
+| Status  | Reason                                                                  |
++---------+-------------------------------------------------------------------------+
+| 595     | The specified route is not handled. This typically means that a service |
+|         | route was specified for a service that was not registered, as opposed   |
+|         | to a method on an end-point in a service not being supported.           |
++---------+-------------------------------------------------------------------------+
+| 596     | An unhandled exception occurred in the StackInABoxService instance that |
+|         | supports the specified route. See logs for details.                     |
++---------+-------------------------------------------------------------------------+
+| 597     | URI is for a service that is unknown.                                   |
++---------+-------------------------------------------------------------------------+

docs/api/services/index.rst

@@ -0,0 +1,10 @@
+Services
+========
+
+.. toctree::
+    :maxdepth: 2
+
+    service
+    router
+    service-exceptions
+    errors

docs/api/services/router.rst

@@ -0,0 +1,17 @@
+.. _router:
+
+StackInABoxService Router
+=========================
+
+StackInABoxService uses a custom router to differentiate between method and
+sub-service routing. This is entirely an internal object.
+
+.. code:: python
+
+	import stackinabox.services.service
+
+	router = stackinabox.services.service.StackInABoxServiceRouter
+
+.. currentmodule:: stackinabox.services.service
+.. autoclass:: StackInABoxServiceRouter
+	:members:

docs/api/services/service-exceptions.rst

@@ -0,0 +1,12 @@
+.. _service-exceptions:
+
+StackInABoxService Exceptions
+=============================
+
+StackInABoxService has several custom exceptions which may come up during
+service and route registration.
+
+.. currentmodule:: stackinabox.services.service
+.. autoexception:: StackInABoxServiceErrors
+.. autoexception:: RouteAlreadyRegisteredError
+.. autoexception:: InvalidRouteRegexError

docs/api/services/service.rst

@@ -0,0 +1,8 @@
+.. _service:
+
+Services
+========
+
+.. currentmodule:: stackinabox.services.service
+.. autoclass:: StackInABoxService
+	:members:

docs/api/stack-exceptions.rst

@@ -0,0 +1,8 @@
+.. _stack-exceptions:
+
+Stack Exceptions
+================
+
+.. currentmodule:: stackinabox.stack
+
+.. autoexception:: ServiceAlreadyRegisteredError

docs/api/stack.rst

@@ -0,0 +1,9 @@
+.. _stack:
+
+Stack
+=====
+
+.. currentmodule:: stackinabox.stack
+
+.. autoclass:: StackInABox
+    :members:

docs/api/utils/httpretty.rst

@@ -0,0 +1,10 @@
+.. _httpretty:
+
+HTTPretty Utility
+=================
+
+StackInABox provides support for writing tests with httpretty.
+
+.. currentmodule:: stackinabox.util_httpretty
+.. autofunction:: httpretty_callback
+.. autofunction:: httpretty_registration

docs/api/utils/index.rst

@@ -0,0 +1,10 @@
+Utilities
+=========
+
+.. toctree::
+    :maxdepth: 2
+
+    insensitive-dict
+    httpretty
+    requests-mock
+    responses

docs/api/utils/insensitive-dict.rst

@@ -0,0 +1,7 @@
+.. _insensitive-dict:
+
+CaseInsensitiveDict
+===================
+
+.. currentmodule:: stackinabox.utils.caseinsensitivedict
+.. autoclass:: CaseInsensitiveDict

docs/api/utils/requests-mock.rst

@@ -0,0 +1,25 @@
+.. _requests-mock:
+
+Requests-Mock Utility
+=====================
+
+StackInABox provides support for writing tests with requests-mock.
+
+.. currentmodule:: stackinabox.util_requests_mock
+.. autoclass:: RequestMockCallable
+	:members:
+.. autofunction:: requests_mock_session_registration
+.. autofunction:: requests_mock_registration
+.. autofunction:: requests_request
+.. autofunction:: requests_get
+.. autofunction:: requests_options
+.. autofunction:: requests_head
+.. autofunction:: requests_post
+.. autofunction:: requests_put
+.. autofunction:: requests_patch
+.. autofunction:: requests_delete
+.. autoclass:: requests_session
+	:members:
+.. autofunction:: get_session
+.. autoclass:: activate
+	:members:

docs/api/utils/responses.rst

@@ -0,0 +1,8 @@
+.. _responses:
+
+Responses Utility
+=================
+
+.. currentmodule:: stackinabox.util_responses
+.. autofunction:: responses_callback
+.. autofunction:: responses_registration

docs/changes/0.1.rst

@@ -0,0 +1,11 @@
+.. _0.1:
+
+ChangeLog for Stack-In-A-Box 0.1
+================================
+
+Initial Release
+
+- Basic Framework is in place
+- Start of OpenStack Keystone API mocking
+
+This release is primarily about the basic framework

docs/changes/0.2.rst

@@ -0,0 +1,18 @@
+.. _0.2:
+
+ChangeLog for Stack-In-A-Box 0.2
+================================
+
+New
+---
+
+
+Breaking Changes
+----------------
+
+
+Fixed
+-----
+
+- DELETE != PUT for Service verbs
+- setup might not have been capturing the package correctly