Docs

README.md

@@ -17,10 +17,13 @@ Install swagger.py using the `setup.py` script.
 
     $ sudo ./setup.py install
 
-<!-- TODO
 swagger-codegen
 ===============
 
+There are the beginnings of a Mustache-based code generator, but it's
+not functional... yet.
+
+<!-- TODO
 Inspired by the original [swagger-codegen][] project, templates are
 written using [Mustache][] templates ([Pystache][], specifically).
 There are several important differences.

doc/.gitignore

@@ -0,0 +1 @@
+build

doc/Makefile

@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.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 "  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 "  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/swagger-py.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/swagger-py.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/swagger-py"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/swagger-py"
+	@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."
+
+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."

doc/source/conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # swagger-py documentation build configuration file, created by
-# sphinx-quickstart on Fri Aug 30 12:45:27 2013.
+# sphinx-quickstart on Wed Oct 16 09:33:48 2013.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -11,6 +11,12 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import sys, 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 -----------------------------------------------------
 
@@ -35,7 +41,6 @@
 
 # General information about the project.
 project = u'swagger-py'
-# noinspection PyShadowingBuiltins
 copyright = u'2013, Digium, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -179,7 +184,7 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('index', 'swagger-py.tex', u'swagger-py Documentation',
-   u'David M. Lee, II; Digium, Inc.', 'manual'),
+   u'Digium, Inc.', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -209,7 +214,7 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'swagger-py', u'swagger-py Documentation',
-     [u'David M. Lee, II; Digium, Inc.'], 1)
+     [u'Digium, Inc.'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -223,7 +228,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   ('index', 'swagger-py', u'swagger-py Documentation',
-   u'David M. Lee, II; Digium, Inc.', 'swagger-py', 'One line description of project.',
+   u'Digium, Inc.', 'swagger-py', 'One line description of project.',
    'Miscellaneous'),
 ]
 

doc/source/index.rst

@@ -1,4 +1,7 @@
-.. Copyright (c) 2013, Digium, Inc.
+.. swagger-py documentation master file, created by
+   sphinx-quickstart on Wed Oct 16 09:33:48 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
 
 Welcome to swagger-py's documentation!
 ======================================
@@ -9,7 +12,7 @@ Contents:
    :maxdepth: 2
 
    swaggerpy
-   client
+   swaggerpy.client
 
 Indices and tables
 ==================

doc/source/modules.rst

@@ -0,0 +1,7 @@
+swaggerpy
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   swaggerpy

doc/source/swaggerpy.client.rst

@@ -0,0 +1,19 @@
+client Package
+==============
+
+:mod:`client` Package
+---------------------
+
+.. automodule:: swaggerpy.client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`client` Module
+--------------------
+
+.. automodule:: swaggerpy.client.client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

doc/source/swaggerpy.rst

@@ -1,7 +1,50 @@
-.. Copyright (c) 2013, Digium, Inc.
-
-Swagger API model
+swaggerpy Package
 =================
 
-.. automodule:: swaggerpy
-   :members: load_file, load_json, load_url, Loader, SwaggerProcessor, SwaggerError
+:mod:`swaggerpy` Package
+------------------------
+
+.. automodule:: swaggerpy.__init__
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`codegen` Module
+---------------------
+
+.. automodule:: swaggerpy.codegen
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`jsonify` Module
+---------------------
+
+.. automodule:: swaggerpy.jsonify
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`processors` Module
+------------------------
+
+.. automodule:: swaggerpy.processors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`swagger_model` Module
+---------------------------
+
+.. automodule:: swaggerpy.swagger_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    swaggerpy.client
+