Documentation update for v0.6.

Author: Fizzadar

docs/facts.rst

@@ -7,68 +7,68 @@ Facts Index
 Files
 -----
 
-:code:`directory(name)`
-~~~~~~~~~~~~~~~~~~~~~~~
+:code:`directory`
+~~~~~~~~~~~~~~~~~
 
 
-:code:`file(name)`
-~~~~~~~~~~~~~~~~~~
+:code:`file`
+~~~~~~~~~~~~
 
 
-:code:`find_directories(name)`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`find_directories`
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 
     Returns a list of directories from a start point, recursively using find.
 
 
 
-:code:`find_files(name)`
-~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`find_files`
+~~~~~~~~~~~~~~~~~~
 
 
     Returns a list of files from a start point, recursively using find.
 
 
 
-:code:`find_in_file(name, pattern)`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`find_in_file`
+~~~~~~~~~~~~~~~~~~~~
 
 
     Checks for the existence of text in a file using grep. Returns a list of matching
     lines if the file exists, and ``None`` if the file does not.
 
 
 
-:code:`find_links(name)`
-~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`find_links`
+~~~~~~~~~~~~~~~~~~
 
 
     Returns a list of links from a start point, recursively using find.
 
 
 
-:code:`link(name)`
-~~~~~~~~~~~~~~~~~~
+:code:`link`
+~~~~~~~~~~~~
 
 
-:code:`sha1_file(name)`
-~~~~~~~~~~~~~~~~~~~~~~~
+:code:`sha1_file`
+~~~~~~~~~~~~~~~~~
 
 
     Returns a SHA1 hash of a file. Works with both sha1sum and sha1.
 
 
 
-:code:`socket(name)`
-~~~~~~~~~~~~~~~~~~~~
+:code:`socket`
+~~~~~~~~~~~~~~
 
 
 Git
 ---
 
-:code:`git_branch(name)`
-~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`git_branch`
+~~~~~~~~~~~~~~~~~~
 
 
 Server
@@ -78,8 +78,8 @@ Server
 ~~~~~~~~~~~~
 
 
-:code:`command(command)`
-~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`command`
+~~~~~~~~~~~~~~~
 
 
 :code:`date`
@@ -168,8 +168,8 @@ Server
 Npm
 ---
 
-:code:`npm_packages(directory)`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`npm_packages`
+~~~~~~~~~~~~~~~~~~~~
 
 
     Returns a dict of installed npm packages globally or in a given directory:
@@ -197,8 +197,8 @@ Yum
     
 
 
-:code:`rpm_package(name)`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`rpm_package`
+~~~~~~~~~~~~~~~~~~~
 
 
     Returns information on a .rpm file:
@@ -255,8 +255,8 @@ Apt
     
 
 
-:code:`deb_package(name)`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`deb_package`
+~~~~~~~~~~~~~~~~~~~
 
 
     Returns information on a .deb file.
@@ -314,8 +314,8 @@ Pkg
 Iptables
 --------
 
-:code:`ip6tables_chains(table)`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`ip6tables_chains`
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 
     Returns a dict of ip6tables chains & policies:
@@ -327,8 +327,8 @@ Iptables
     
 
 
-:code:`ip6tables_rules(table)`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`ip6tables_rules`
+~~~~~~~~~~~~~~~~~~~~~~~
 
 
     Returns a list of ip6tables rules for a specific table:
@@ -343,8 +343,8 @@ Iptables
     
 
 
-:code:`iptables_chains(table)`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`iptables_chains`
+~~~~~~~~~~~~~~~~~~~~~~~
 
 
     Returns a dict of iptables chains & policies:
@@ -356,8 +356,8 @@ Iptables
     
 
 
-:code:`iptables_rules(table)`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`iptables_rules`
+~~~~~~~~~~~~~~~~~~~~~~
 
 
     Returns a list of iptables rules for a specific table:
@@ -375,8 +375,8 @@ Iptables
 Pip
 ---
 
-:code:`pip_packages(pip)`
-~~~~~~~~~~~~~~~~~~~~~~~~~
+:code:`pip_packages`
+~~~~~~~~~~~~~~~~~~~~
 
 
     Returns a dict of installed pip packages:

docs/modules/git.rst

@@ -12,7 +12,7 @@ Manage git repositories.
 .. code:: python
 
     git.repo(
-        source, target, branch=master, pull=True, rebase=False, user=None, group=None,
+        source, target, branch='master', pull=True, rebase=False, user=None, group=None,
         use_ssh_user=False, ssh_keyscan=False
     )
 

docs/modules/iptables.rst

@@ -11,7 +11,7 @@ Manage iptables chains.
 
 .. code:: python
 
-    iptables.chain(name, present=True, table=filter, policy=None, version=4)
+    iptables.chain(name, present=True, table='filter', policy=None, version=4)
 
 + **name**: the name of the chain
 + **present**: whether the chain should exist
@@ -31,11 +31,11 @@ Manage iptables rules.
 .. code:: python
 
     iptables.rule(
-        chain, jump, present=True, table=filter, append=True, version=4, protocol=None,
+        chain, jump, present=True, table='filter', append=True, version=4, protocol=None,
         not_protocol=None, source=None, not_source=None, destination=None, not_destination=None,
         in_interface=None, not_in_interface=None, out_interface=None, not_out_interface=None,
         to_destination=None, to_source=None, to_ports=None, log_prefix=None,
-        destination_port=None, source_port=None, extras=
+        destination_port=None, source_port=None, extras=''
     )
 
 + **chain**: the chain this rule should live in

docs/modules/lxd.rst

@@ -11,7 +11,7 @@ Manage LXD containers.
 
 .. code:: python
 
-    lxd.container(name, present=True, image=ubuntu:16.04)
+    lxd.container(name, present=True, image='ubuntu:16.04')
 
 Note: does not check if an existing container is based on the specified
 image.

docs/modules/pip.rst

@@ -12,7 +12,7 @@ Manage pip packages.
 .. code:: python
 
     pip.packages(
-        packages=None, present=True, latest=False, requirements=None, pip=pip, virtualenv=None,
+        packages=None, present=True, latest=False, requirements=None, pip='pip', virtualenv=None,
         virtualenv_kwargs=None
     )