updated documentation

Thomas · Thomas · commit d95da0756b41 · 2020-03-20T14:53:25.000+01:00
diff --git a/docs/authentication.rst b/docs/authentication.rst
@@ -0,0 +1,10 @@
+##############################################
+Authentication
+##############################################
+
+By default you can get all the information from Netbox if the login_required option is set to False. If the option is
+set to True, you can access the api by username and password to GET the information. The API is only writable if you
+have a Token.
+
+* Use the auth_token parameter for the writeable api
+* Use the auth parameter to use username and password. The auth parameter is a tuple ('username','password')
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -1,27 +1,12 @@
 ##############################################
-How to Use
+Examples
 ##############################################
 
-Authentication
-==============
-
-By default you can get all the information from Netbox if the login_required option is set to False. If the option is
-set to True, you can access the api by username and password to GET the information. The API is only writable if you
-have a Token.
-
-* Use the auth_token parameter for the writeable api
-* Use the auth parameter to use username and password. The auth parameter is a tuple ('username','password')
-
-Usage
-=====
-
 To start with python-netbox client:
 
     >>> from netbox import NetBox
     >>> netbox = NetBox(host='127.0.0.1', port=32768, use_ssl=False, auth_token='token')
 
-Examples
-========
 
 Get all devices:
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,26 +8,15 @@ Python Netbox Client
 
 python-netbox is a client for the Netbox (https://github.com/digitalocean/netbox) API. It's based on the APIv2 which is released since version 2.0.0. It requires python 3.
 
-Installation
-============
-
-To get the latest version from Github::
-
-   pip install python-netbox
-
 
 Contents
 ========
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   netbox
+   installation
+   authentication
    examples
 
-
-
 Indices and tables
 ==================
 
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,13 @@
+##############################################
+Installation
+##############################################
+
+
+To get the latest version from Github::
+
+   pip install python-netbox
+
+To install the latest version from the master branch::
+
+   pip install  pip install https://github.com/jagter/python-netbox/archive/master.zip
+
diff --git a/docs/netbox.rst.old b/docs/netbox.rst.old
diff --git a/docs/source/netbox.rst b/docs/source/netbox.rst
@@ -1,50 +1,69 @@
 netbox package
 ==============
 
-The ``dcim`` class
+Submodules
+----------
+
+netbox.connection module
+------------------------
+
+.. automodule:: netbox.connection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+netbox.dcim module
 ------------------
 
-.. autoclass:: netbox.dcim
+.. automodule:: netbox.dcim
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+netbox.exceptions module
+------------------------
+
+.. automodule:: netbox.exceptions
    :members:
    :undoc-members:
    :show-inheritance:
 
-The ``extras`` class
+netbox.extras module
 --------------------
 
-.. autoclass:: netbox.extras
+.. automodule:: netbox.extras
    :members:
    :undoc-members:
    :show-inheritance:
 
-The ``ipam`` class
+netbox.ipam module
 ------------------
 
-.. autoclass:: netbox.ipam
+.. automodule:: netbox.ipam
    :members:
    :undoc-members:
    :show-inheritance:
 
-The ``netbox`` class
+netbox.netbox module
 --------------------
 
-.. autoclass:: netbox.netbox
+.. automodule:: netbox.netbox
    :members:
    :undoc-members:
    :show-inheritance:
 
-The ``tenancy`` class
+netbox.tenancy module
 ---------------------
 
-.. autoclass:: netbox.tenancy
+.. automodule:: netbox.tenancy
    :members:
    :undoc-members:
    :show-inheritance:
 
-The ``virtualization`` class
+netbox.virtualization module
 ----------------------------
 
-.. autoclass:: netbox.virtualization
+.. automodule:: netbox.virtualization
    :members:
    :undoc-members:
    :show-inheritance:
@@ -53,7 +72,7 @@ The ``virtualization`` class
 Module contents
 ---------------
 
-.. autoclass:: netbox
+.. automodule:: netbox
    :members:
    :undoc-members:
    :show-inheritance:
