small documentation improvements

gijzelaerr · Feb 19, 2016 · a769586 · a769586
1 parent 83e4dad
commit a769586
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -113,7 +114,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -1,5 +1,5 @@
-machine package
-===============
+Usage
+=====
 
 .. automodule:: machine.machine
     :members:

diff --git a/machine/machine.py b/machine/machine.py
@@ -290,7 +290,7 @@ def active(self):
         Print which machine is active
 
         Returns:
-            List[str}: a list of machines that are active
+            List[str]: a list of machines that are active
         """
         cmd = ["active"]
         stdout, stderr, error_code = self._run(cmd, raise_error=False)