From: Tim Van Steenburgh <tvansteenburgh@gmail.com>
Date: Wed, 30 Nov 2016 05:02:46 +0000 (-0500)
Subject: Start getting docs updated
X-Git-Tag: 0.1.0~23
X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=46a88984bea38b309d3e0d7c1d16bd904bb04db4;p=osm%2FN2VC.git

Start getting docs updated
---

diff --git a/Makefile b/Makefile
index eee4757..04bc522 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,6 @@
-PY := .tox/py35/bin/python3.5
+BIN := .tox/py35/bin
+PY := $(BIN)/python3.5
+PIP := $(BIN)/pip
 
 clean:
 	find . -name __pycache__ -type d -exec rm -r {} +
@@ -14,4 +16,10 @@ client:
 test:
 	tox
 
-.phony: clean client test
+docs: .tox
+	$(PIP) list | grep Sphinx || $(PIP) install -U sphinx
+	rm -rf docs/api/*
+	$(BIN)/sphinx-apidoc -o docs/api/ juju/
+	$(BIN)/sphinx-build -b html docs/  docs/_build/
+
+.PHONY: clean client test docs
diff --git a/docs/api/juju.client.rst b/docs/api/juju.client.rst
new file mode 100644
index 0000000..909b788
--- /dev/null
+++ b/docs/api/juju.client.rst
@@ -0,0 +1,70 @@
+juju.client package
+===================
+
+Submodules
+----------
+
+juju.client.client module
+-------------------------
+
+.. automodule:: juju.client.client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.client.codegen module
+--------------------------
+
+.. automodule:: juju.client.codegen
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.client.connection module
+-----------------------------
+
+.. automodule:: juju.client.connection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.client.facade module
+-------------------------
+
+.. automodule:: juju.client.facade
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.client.overrides module
+----------------------------
+
+.. automodule:: juju.client.overrides
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.client.runner module
+-------------------------
+
+.. automodule:: juju.client.runner
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.client.watcher module
+--------------------------
+
+.. automodule:: juju.client.watcher
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: juju.client
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api/juju.rst b/docs/api/juju.rst
index 22acc7c..bf002f6 100644
--- a/docs/api/juju.rst
+++ b/docs/api/juju.rst
@@ -1,9 +1,40 @@
 juju package
 ============
 
+Subpackages
+-----------
+
+.. toctree::
+
+    juju.client
+
 Submodules
 ----------
 
+juju.action module
+------------------
+
+.. automodule:: juju.action
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.annotation module
+----------------------
+
+.. automodule:: juju.annotation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.application module
+-----------------------
+
+.. automodule:: juju.application
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 juju.cloud module
 -----------------
 
@@ -12,6 +43,14 @@ juju.cloud module
     :undoc-members:
     :show-inheritance:
 
+juju.constraints module
+-----------------------
+
+.. automodule:: juju.constraints
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 juju.controller module
 ----------------------
 
@@ -20,6 +59,30 @@ juju.controller module
     :undoc-members:
     :show-inheritance:
 
+juju.delta module
+-----------------
+
+.. automodule:: juju.delta
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.errors module
+------------------
+
+.. automodule:: juju.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.exceptions module
+----------------------
+
+.. automodule:: juju.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 juju.juju module
 ----------------
 
@@ -44,10 +107,18 @@ juju.model module
     :undoc-members:
     :show-inheritance:
 
-juju.service module
--------------------
+juju.placement module
+---------------------
+
+.. automodule:: juju.placement
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+juju.relation module
+--------------------
 
-.. automodule:: juju.service
+.. automodule:: juju.relation
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
index d65e5ad..dbedff3 100644
--- a/docs/api/modules.rst
+++ b/docs/api/modules.rst
@@ -1,5 +1,5 @@
-API Docs
-========
+juju
+====
 
 .. toctree::
    :maxdepth: 4