updated docs

Author: Thomas

Diff for: docs/conf.py

@@ -19,7 +19,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- General configuration ------------------------------------------------
@@ -83,7 +83,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+# 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
@@ -94,7 +94,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 
 # -- Options for HTMLHelp output ------------------------------------------

Diff for: docs/examples.rst

@@ -29,11 +29,11 @@ Get all devices:
 
 Get devices per rack:
 
-    >>> netbox.dcim.get_devices_per_rack('rack_name')
+    >>> netbox.dcim.get_devices(rack_id='1')
 
 Get device by name
 
-    >>> netbox.dcim.get_device_by_name('device_name')
+    >>> netbox.dcim.get_devices(name='device_name')
 
 Get per device the primary ip and mac address:
 

Diff for: docs/netbox.rst

@@ -4,14 +4,6 @@ netbox package
 Submodules
 ----------
 
-netbox\.connection module
--------------------------
-
-.. automodule:: netbox.connection
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 netbox\.dcim module
 -------------------
 
@@ -20,14 +12,6 @@ netbox\.dcim module
     :undoc-members:
     :show-inheritance:
 
-netbox\.exceptions module
--------------------------
-
-.. automodule:: netbox.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 netbox\.ipam module
 -------------------
 
@@ -36,14 +20,6 @@ netbox\.ipam module
     :undoc-members:
     :show-inheritance:
 
-netbox\.netbox module
----------------------
-
-.. automodule:: netbox.netbox
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 netbox\.virtualization module
 ---------------------
 

Diff for: docs/source/netbox.rst

@@ -4,14 +4,6 @@ netbox package
 Submodules
 ----------
 
-netbox\.connection module
--------------------------
-
-.. automodule:: netbox.connection
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 netbox\.dcim module
 -------------------
 
@@ -20,14 +12,6 @@ netbox\.dcim module
     :undoc-members:
     :show-inheritance:
 
-netbox\.exceptions module
--------------------------
-
-.. automodule:: netbox.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 netbox\.ipam module
 -------------------
 
@@ -36,15 +20,6 @@ netbox\.ipam module
     :undoc-members:
     :show-inheritance:
 
-netbox\.netbox module
----------------------
-
-.. automodule:: netbox.netbox
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
 Module contents
 ---------------