Added .gitreview

Change-Id: I42f5bbb4a6bc12445c3ea571134a614395b0fd34

.gitignore

@@ -22,3 +22,9 @@ ChangeLog
 
 # Coverage data
 .coverage.*
+
+# sphinx
+doc/source/_static/nova.conf.sample
+doc/source/api/*
+doc/build/*
+

.gitreview

@@ -0,0 +1,4 @@
+[gerrit]
+host=review.openstack.org
+port=29418
+project=openstack/freezer-dr.git

doc/.gitignore

@@ -1,3 +0,0 @@
-build/
-source/ref/
-source/api/

doc/source/_static/test.css

@@ -0,0 +1,47 @@
+
+.sp_feature_mandatory {
+    font-weight: bold;
+}
+
+.sp_feature_optional {
+}
+
+.sp_feature_choice {
+    font-style: italic;
+    font-weight: bold;
+}
+
+.sp_feature_condition {
+    font-style: italic;
+    font-weight: bold;
+}
+
+
+.sp_impl_complete {
+    color: rgb(0, 120, 0);
+    font-weight: normal;
+}
+
+.sp_impl_missing {
+    color: rgb(120, 0, 0);
+    font-weight: normal;
+}
+
+.sp_impl_partial {
+    color: rgb(170, 170, 0);
+    font-weight: normal;
+}
+
+.sp_impl_unknown {
+    color: rgb(170, 170, 170);
+    font-weight: normal;
+}
+
+.sp_impl_summary {
+    font-size: 2em;
+}
+
+.sp_cli {
+    font-family: monospace;
+    background-color: #F5F5F5;
+}

doc/source/index.rst

@@ -19,3 +19,11 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+.. toctree::
+   :maxdepth: 1
+
+   api/autoindex
+
+.. toctree::
+   :hidden:

freezer_dr/common/osclient.py

@@ -164,8 +164,8 @@ class OSClient:
         return auth_session
 
     def get_node_status(self, node):
-        """Check the node nova-service status and if it's disabled or not.
-
+        """
+        Check the node nova-service status and if it's disabled or not.
         :param node: dict contains node info
         :return: True or False. True => node disabled, False => node is enabled
         or unknow status !

freezer_dr/monitors/drivers/dummy/driver.py

@@ -15,12 +15,12 @@ from freezer_dr.monitors.common.driver import MonitorBaseDriver
 
 
 class DummyDriver(MonitorBaseDriver):
-    """ A monitoring driver that returns a configured list of nodes as failed.
-
+    """ 
+    A monitoring driver that returns a configured list of nodes as failed.
     This can be useful for testing without actually shutting down the nodes.
     The nodes that should be reported as failing, can be configured in the
     monitoring section of the freezer_dr configuration file as follows:
-       kwargs = nodes_down:hostname1;hostname2
+    kwargs = nodes_down:hostname1;hostname2
     """
 
     def __init__(self, username, password, endpoint, **kwargs):

freezer_dr/notifiers/common/manager.py

@@ -38,7 +38,7 @@ class NotificationManager(object):
     def notify(self, nodes, status):
         """
         Send Notification to users added on tenants that has VMs running on the
-         affected host.
+        affected host.
         :param nodes: List of hosts that are affected, contains instances
         running on those hosts, tenants, users added on those tenants.
         :param status: success or error

requirements.txt

@@ -9,3 +9,4 @@ oslo.utils>=1.4.0,!=1.4.1,<1.5.0
 oslo.log>=1.0.0,<1.1.0  # Apache-2.0
 libvirt-python>=1.2.5
 Jinja2>=2.6
+

setup.cfg

@@ -45,6 +45,8 @@ build-dir = doc/build
 all_files = 1
 
 [pbr]
+# Have pbr generate the module indexes like sphinx autodoc
+autodoc_index_modules = True
 warnerrors = True
 
 

test-requirements.txt

@@ -14,4 +14,5 @@ python-subunit>=0.0.18
 pyflakes==0.8.1
 testrepository>=0.0.18
 testtools>=0.9.36,!=1.2.0,<2.0.0
-
+oslosphinx>=2.5.0,!=3.4.0  # Apache-2.0
+sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3  # BSD

tox.ini

@@ -30,6 +30,10 @@ norecursedirs  = .tox .venv
 [testenv:venv]
 commands = {posargs}
 
+[testenv:docs]
+commands =
+  python setup.py build_sphinx
+
 [testenv:py27]
 basepython = python2.7
 setenv =