Updated Changelog to have proper format, added changelog to Sphinx docs, and updated docs. (#309)

Author: FragmentedPacket

CHANGELOG.md

@@ -45,19 +45,19 @@ Breaking Changes / Porting Guide
 
   ::
 
-  tasks:
-    - name: Create device within NetBox with only required information
-      netbox_device:
-        netbox_url: http://netbox-demo.org:32768
-        netbox_token: 0123456789abcdef0123456789abcdef01234567
-        data:
-          name: Test66
-          device_type:
-            id: "{{ some_jinja_variable }}"
-          device_role: Core Switch
-          site: Test Site
-          status: Staged
-        state: present
+    tasks:
+      - name: Create device within NetBox with only required information
+        netbox_device:
+          netbox_url: http://netbox-demo.org:32768
+          netbox_token: 0123456789abcdef0123456789abcdef01234567
+          data:
+            name: Test66
+            device_type:
+              id: "{{ some_jinja_variable }}"
+            device_role: Core Switch
+            site: Test Site
+            status: Staged
+          state: present
 - ``pynetbox`` changed to using ``requests.Session()`` to manage the HTTP session
   which broke passing in ``ssl_verify`` when building the NetBox API client.
   This PR makes ``pynetbox 5.0.4+`` the new required version of `pynetbox` for
@@ -90,9 +90,9 @@ Minor Changes
 
 - Adds ``discovered`` field to ``netbox_inventory_item`` (https://github.com/netbox-community/ansible_modules/issues/187)
 - Adds ``query_params`` to all modules to allow users to define the ``query_params`` (https://github.com/netbox-community/ansible_modules/issues/215)
-- Adds ``tenant`` field to `netbox_cluster` (https://github.com/netbox-community/ansible_modules/pull/219)
+- Adds ``tenant`` field to ``netbox_cluster`` (https://github.com/netbox-community/ansible_modules/pull/219)
 - Allows private key to be passed in to ``validate_certs`` within modules (https://github.com/netbox-community/ansible_modules/issues/216)
-- Better error handling if read-only token is provided for modules. Updated README as well to say that a `write-enabled` token is required (https://github.com/netbox-community/ansible_modules/pull/238)
+- Better error handling if read-only token is provided for modules. Updated README as well to say that a ``write-enabled`` token is required (https://github.com/netbox-community/ansible_modules/pull/238)
 
 Bugfixes
 --------
@@ -125,14 +125,14 @@ v0.2.2
 Minor Changes
 -------------
 
-- Changed ``validate_certs`` to ``raw1` to allow private keys to be passed in (https://github.com/netbox-community/ansible_modules/issues/211)
+- Changed ``validate_certs`` to ``raw`` to allow private keys to be passed in (https://github.com/netbox-community/ansible_modules/issues/211)
 
 Bugfixes
 --------
 
+- Added ``interfaces`` to ``ALLOWED_QUERY_PARAMS`` for ip addresses searches (https://github.com/netbox-community/ansible_modules/issues/201)
 - Added ``type`` to ``ALLOWED_QUERY_PARAMS`` for interface searches (https://github.com/netbox-community/ansible_modules/issues/208)
-- Added `interfaces` to `ALLOWED_QUERY_PARAMS` for ip addresses searches (https://github.com/netbox-community/ansible_modules/issues/201)
-- Remove `rack` as a choice when createing virtual machines (https://github.com/netbox-community/ansible_modules/pull/221)
+- Remove ``rack`` as a choice when creating virtual machines (https://github.com/netbox-community/ansible_modules/pull/221)
 
 v0.2.1
 ======
@@ -196,13 +196,13 @@ Breaking Changes / Porting Guide
 
 - This version has a few breaking changes due to new namespace and collection name. I felt it necessary to change the name of the lookup plugin and inventory plugin just not to have a non descriptive namespace call to use them. Below is an example:
   ``netbox.netbox.netbox`` would be used for both inventory plugin and lookup plugin, but in different contexts so no collision will arise, but confusion will.
-  I renamed the lookup plugin to `nb_lookup` so it will be used with the FQCN ``netbox.netbox.nb_lookup``.
+  I renamed the lookup plugin to ``nb_lookup`` so it will be used with the FQCN ``netbox.netbox.nb_lookup``.
   The inventory plugin will now be called within an inventory file by ``netbox.netbox.nb_inventory``
 
 Bugfixes
 --------
 
-- Update netbox_tenant and netbox_tenant_group to use slugs for searching (available since NetBox 2.6). Added slug options to netbox_site, netbox_tenant, netbox_tenant_group (https://github.com/netbox-community/ansible_modules/pull/120)
+- Update ``netbox_tenant`` and ``netbox_tenant_group`` to use slugs for searching (available since NetBox 2.6). Added slug options to netbox_site, netbox_tenant, netbox_tenant_group (https://github.com/netbox-community/ansible_modules/pull/120)
 
 v0.1.8
 ======

CHANGELOG.rst

@@ -174,14 +174,14 @@ releases:
           plugin, but in different contexts so no collision will arise, but confusion
           will.
 
-          I renamed the lookup plugin to `nb_lookup` so it will be used with the FQCN
+          I renamed the lookup plugin to ``nb_lookup`` so it will be used with the FQCN
           ``netbox.netbox.nb_lookup``.
 
           The inventory plugin will now be called within an inventory file by ``netbox.netbox.nb_inventory``
 
           "
       bugfixes:
-        - Update netbox_tenant and netbox_tenant_group to use slugs for searching (available
+        - Update ``netbox_tenant`` and ``netbox_tenant_group`` to use slugs for searching (available
           since NetBox 2.6). Added slug options to netbox_site, netbox_tenant, netbox_tenant_group
           (https://github.com/netbox-community/ansible_modules/pull/120)
   0.2.0:
@@ -235,10 +235,10 @@ releases:
     changes:
       bugfixes:
         - Added ``type`` to ``ALLOWED_QUERY_PARAMS`` for interface searches (https://github.com/netbox-community/ansible_modules/issues/208)
-        - Added `interfaces` to `ALLOWED_QUERY_PARAMS` for ip addresses searches (https://github.com/netbox-community/ansible_modules/issues/201)
-        - Remove `rack` as a choice when createing virtual machines (https://github.com/netbox-community/ansible_modules/pull/221)
+        - Added ``interfaces`` to ``ALLOWED_QUERY_PARAMS`` for ip addresses searches (https://github.com/netbox-community/ansible_modules/issues/201)
+        - Remove ``rack`` as a choice when creating virtual machines (https://github.com/netbox-community/ansible_modules/pull/221)
       minor_changes:
-        - Changed ``validate_certs`` to ``raw1` to allow private keys to be passed in
+        - Changed ``validate_certs`` to ``raw`` to allow private keys to be passed in
           (https://github.com/netbox-community/ansible_modules/issues/211)
   0.2.3:
     changes:
@@ -253,10 +253,10 @@ releases:
         - Adds ``discovered`` field to ``netbox_inventory_item`` (https://github.com/netbox-community/ansible_modules/issues/187)
         - Adds ``query_params`` to all modules to allow users to define the ``query_params``
           (https://github.com/netbox-community/ansible_modules/issues/215)
-        - Adds ``tenant`` field to `netbox_cluster` (https://github.com/netbox-community/ansible_modules/pull/219)
+        - Adds ``tenant`` field to ``netbox_cluster`` (https://github.com/netbox-community/ansible_modules/pull/219)
         - Allows private key to be passed in to ``validate_certs`` within modules (https://github.com/netbox-community/ansible_modules/issues/216)
         - Better error handling if read-only token is provided for modules. Updated
-          README as well to say that a `write-enabled` token is required (https://github.com/netbox-community/ansible_modules/pull/238)
+          README as well to say that a ``write-enabled`` token is required (https://github.com/netbox-community/ansible_modules/pull/238)
     modules:
       - description: Create, update or delete console ports within Netbox
         name: netbox_console_port
@@ -314,19 +314,19 @@ releases:
 
           ::
 
-          tasks:
-            - name: Create device within NetBox with only required information
-              netbox_device:
-                netbox_url: http://netbox-demo.org:32768
-                netbox_token: 0123456789abcdef0123456789abcdef01234567
-                data:
-                  name: Test66
-                  device_type:
-                    id: "{{ some_jinja_variable }}"
-                  device_role: Core Switch
-                  site: Test Site
-                  status: Staged
-                state: present
+            tasks:
+              - name: Create device within NetBox with only required information
+                netbox_device:
+                  netbox_url: http://netbox-demo.org:32768
+                  netbox_token: 0123456789abcdef0123456789abcdef01234567
+                  data:
+                    name: Test66
+                    device_type:
+                      id: "{{ some_jinja_variable }}"
+                    device_role: Core Switch
+                    site: Test Site
+                    status: Staged
+                  state: present
 
         - |
           ``pynetbox`` changed to using ``requests.Session()`` to manage the HTTP session

changelogs/changelog.yaml

@@ -3,8 +3,6 @@ Advanced Topics
 
 This will be updated in the future to document advanced features such as passing in ``query_params`` to modules.
 
-.. toctree::
-   :maxdepth: 4
-   :glob:
 
-   */index
+.. toctree::
+   :maxdepth: 4

docs/advanced/index.rst

@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.rst

docs/changelog/changelog_include.rst

@@ -0,0 +1,5 @@
+
+.. toctree::
+   :maxdepth: 4
+
+   changelog_include

docs/changelog/index.rst

@@ -77,4 +77,7 @@ This will cover the basic usage of the NetBox inventory plugin within this colle
 5. Create inventory and select ``source from project``.
 6. Select the AWX/Tower project from Step 2
 7. Select the ``inventory.yml`` file in the project from Step 3
-8. Click ``Save`` and sync source.
+8. Click ``Save`` and sync source.
+
+.. toctree::
+   :maxdepth: 4

docs/getting_started/index.rst

@@ -5,14 +5,16 @@ netbox.netbox Ansible Collection's documentation!
 Overview
 ========
 
-This is the documentation home of the `netbox.netbox` Ansible Collection. We will provide some examples of using all the different plugins included with this collection.
+This is the documentation home of the **netbox.netbox** Ansible Collection. We will provide some examples of using all the different plugins included with this collection.
 
 Contents
 ========
+
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 4
 
    Home <self>
    Getting Started <getting_started/index>
    Advanced Usage <advanced/index>
    Plugins <plugins/index>
+   Changelog <changelog/index>

docs/index.rst

@@ -28,7 +28,7 @@ netbox.netbox.nb_lookup -- Queries and returns elements from Netbox
 
 .. version_added
 
-.. versionadded:: 2.9 of netbox.netbox
+.. versionadded:: 2.9 of 
 
 .. contents::
    :local:

docs/plugins/lookup/nb_lookup/netbox.netbox.nb_lookup_lookup.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_aggregate -- Creates or removes aggregates from Netbox
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_aggregate/netbox.netbox.netbox_aggregate_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_cable -- Create, update or delete cables within Netbox
 
 .. version_added
 
-.. versionadded:: 0.3.0 of netbox.netbox
+.. versionadded:: 0.3.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_cable/netbox.netbox.netbox_cable_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_circuit -- Create, update or delete circuits within Netbox
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_circuit/netbox.netbox.netbox_circuit_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_circuit_termination -- Create, update or delete circuit ter
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_circuit_termination/netbox.netbox.netbox_circuit_termination_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_circuit_type -- Create, update or delete circuit types with
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_circuit_type/netbox.netbox.netbox_circuit_type_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_cluster -- Create, update or delete clusters within Netbox
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_cluster/netbox.netbox.netbox_cluster_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_cluster_group -- Create, update or delete cluster groups wi
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_cluster_group/netbox.netbox.netbox_cluster_group_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_cluster_type -- Create, update or delete cluster types with
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_cluster_type/netbox.netbox.netbox_cluster_type_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_console_port -- Create, update or delete console ports with
 
 .. version_added
 
-.. versionadded:: 0.2.3 of netbox.netbox
+.. versionadded:: 0.2.3 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_console_port/netbox.netbox.netbox_console_port_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_console_port_template -- Create, update or delete console p
 
 .. version_added
 
-.. versionadded:: 0.2.3 of netbox.netbox
+.. versionadded:: 0.2.3 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_console_port_template/netbox.netbox.netbox_console_port_template_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_console_server_port -- Create, update or delete console ser
 
 .. version_added
 
-.. versionadded:: 0.2.3 of netbox.netbox
+.. versionadded:: 0.2.3 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_console_server_port/netbox.netbox.netbox_console_server_port_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_console_server_port_template -- Create, update or delete co
 
 .. version_added
 
-.. versionadded:: 0.2.3 of netbox.netbox
+.. versionadded:: 0.2.3 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_console_server_port_template/netbox.netbox.netbox_console_server_port_template_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_device -- Create, update or delete devices within Netbox
 
 .. version_added
 
-.. versionadded:: 2.8 of netbox.netbox
+.. versionadded:: 2.8 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_device/netbox.netbox.netbox_device_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_device_bay -- Create, update or delete device bays within N
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_device_bay/netbox.netbox.netbox_device_bay_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_device_bay_template -- Create, update or delete device bay
 
 .. version_added
 
-.. versionadded:: 0.3.0 of netbox.netbox
+.. versionadded:: 0.3.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_device_bay_template/netbox.netbox.netbox_device_bay_template_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_device_interface -- Creates or removes interfaces on device
 
 .. version_added
 
-.. versionadded:: 2.8 of netbox.netbox
+.. versionadded:: 2.8 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_device_interface/netbox.netbox.netbox_device_interface_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_device_interface_template -- Creates or removes interfaces
 
 .. version_added
 
-.. versionadded:: 0.3.0 of netbox.netbox
+.. versionadded:: 0.3.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_device_interface_template/netbox.netbox.netbox_device_interface_template_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_device_role -- Create, update or delete devices roles withi
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_device_role/netbox.netbox.netbox_device_role_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_device_type -- Create, update or delete device types within
 
 .. version_added
 
-.. versionadded:: 0.1.0 of netbox.netbox
+.. versionadded:: 0.1.0 of 
 
 .. contents::
    :local:

docs/plugins/modules/netbox_device_type/netbox.netbox.netbox_device_type_module.rst

@@ -28,7 +28,7 @@ netbox.netbox.netbox_front_port -- Create, update or delete front ports within N
 
 .. version_added
 
-.. versionadded:: 0.2.3 of netbox.netbox
+.. versionadded:: 0.2.3 of 
 
 .. contents::
    :local: