Updated docs_requirements.txt, fixed warnings and api.admin docs.

Author: mboersma

docs/docs_requirements.txt

@@ -1,22 +1,31 @@
 # Deis requirements for Sphinx documentation generation
+# This avoids readthedocs.org having to install many packages that aren't
+# actually needed to make the docs, while honoring their limitation of
+# one requirements file. Please keep it up-to-date with the root
+# requirements.txt and dev_requirements.txt files.
+#
+# NOTE: For testing on Mac OS X Mavericks, use the following to work around a clang issue:
+# ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future pip install [pycrypto]
+#
 boto==2.23.0
 celery==3.1.8
 Django==1.6.2
 django-allauth==0.15.0
 django-guardian==1.1.1
 django-json-field==0.5.5
 djangorestframework==2.3.12
-dop==0.1.4
+dop==0.1.6
 gunicorn==18.0
 paramiko==1.12.1
 pyrax==1.6.2
 python-etcd==0.3.0
 PyYAML==3.10
+South==0.8.4
 
 # Deis client requirements
 docopt==0.6.1
 
 # Deis documentation requirements
-Sphinx>=1.2.1
+Sphinx>=1.2.2
 smartypants>=1.8.3
 sphinxcontrib-httpdomain>=1.2.0

docs/gettingstarted/architecture.rst

@@ -10,7 +10,7 @@ Architecture
 Deis consists of 9 modules that combine to create a distributed PaaS.
 Each Deis module is deployed as a :ref:`Container`.
 
-.. _controller:
+.. _arch_controller:
 
 Controller
 ----------
@@ -59,7 +59,7 @@ The builder:
  #. Pushes the new Docker image to the platform's :ref:`Registry`
  #. Creates a new :ref:`Release` on the :ref:`Controller`
 
-Once a new :ref:`Release` is generated, a new set of containers 
+Once a new :ref:`Release` is generated, a new set of containers
 is deployed across the platform automatically.
 
 .. _registry:
@@ -68,15 +68,15 @@ Registry
 --------
 
 The registry module hosts `Docker`_ images on behalf of the platform.
-Image data is typically stored on a storage service like 
+Image data is typically stored on a storage service like
 `Amazon S3`_ or `OpenStack Storage`_.
 
 .. _logserver:
 
 Log Server
 ----------
 
-The log server module uses `rsyslog`_ to aggregate log data from 
+The log server module uses `rsyslog`_ to aggregate log data from
 across the platform.
 This data can then be queried by the :ref:`Controller`.
 
@@ -93,7 +93,7 @@ Proxy
 -----
 
 The proxy module uses `Nginx`_ to route traffic to application containers.
- 
+
 .. _`Django`: https://www.djangoproject.com/
 .. _`Celery`: http://www.celeryproject.org/
 .. _`PostgreSQL`: http://www.postgresql.org/

requirements.txt

@@ -1,4 +1,8 @@
 # Deis controller requirements
+#
+# NOTE: For testing on Mac OS X Mavericks, use the following to work around a clang issue:
+# ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future pip install [pycrypto]
+#
 boto==2.23.0
 celery==3.1.8
 Django==1.6.2