From baf045aed656b20e2fb473b2642adb9193076d0b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 15 Sep 2021 11:46:58 -0400 Subject: [PATCH] Clean up documentation build warnings --- docs/administration/permissions.md | 2 +- docs/core-functionality/circuits.md | 10 ++++---- docs/core-functionality/device-types.md | 20 ++++++++-------- docs/core-functionality/devices.md | 28 +++++++++++----------- docs/core-functionality/ipam.md | 16 ++++++------- docs/core-functionality/power.md | 6 ++--- docs/core-functionality/services.md | 2 +- docs/core-functionality/sites-and-racks.md | 14 +++++------ docs/core-functionality/tenancy.md | 4 ++-- docs/core-functionality/virtualization.md | 10 ++++---- docs/core-functionality/vlans.md | 4 ++-- docs/customization/custom-scripts.md | 2 +- docs/customization/reports.md | 2 +- docs/models/dcim/cable.md | 2 +- docs/rest-api/authentication.md | 2 +- mkdocs.yml | 6 ++--- 16 files changed, 64 insertions(+), 66 deletions(-) diff --git a/docs/administration/permissions.md b/docs/administration/permissions.md index c7c8996dca..97b691c1d8 100644 --- a/docs/administration/permissions.md +++ b/docs/administration/permissions.md @@ -2,7 +2,7 @@ NetBox v2.9 introduced a new object-based permissions framework, which replace's Django's built-in permissions model. Object-based permissions enable an administrator to grant users or groups the ability to perform an action on arbitrary subsets of objects in NetBox, rather than all objects of a certain type. For example, it is possible to grant a user permission to view only sites within a particular region, or to modify only VLANs with a numeric ID within a certain range. -{!docs/models/users/objectpermission.md!} +{!models/users/objectpermission.md!} ### Example Constraint Definitions diff --git a/docs/core-functionality/circuits.md b/docs/core-functionality/circuits.md index 51261858c3..b1b02e3005 100644 --- a/docs/core-functionality/circuits.md +++ b/docs/core-functionality/circuits.md @@ -1,10 +1,10 @@ # Circuits -{!docs/models/circuits/provider.md!} -{!docs/models/circuits/providernetwork.md!} +{!models/circuits/provider.md!} +{!models/circuits/providernetwork.md!} --- -{!docs/models/circuits/circuit.md!} -{!docs/models/circuits/circuittype.md!} -{!docs/models/circuits/circuittermination.md!} +{!models/circuits/circuit.md!} +{!models/circuits/circuittype.md!} +{!models/circuits/circuittermination.md!} diff --git a/docs/core-functionality/device-types.md b/docs/core-functionality/device-types.md index a965f51f0a..037d3cfd03 100644 --- a/docs/core-functionality/device-types.md +++ b/docs/core-functionality/device-types.md @@ -1,7 +1,7 @@ # Device Types -{!docs/models/dcim/devicetype.md!} -{!docs/models/dcim/manufacturer.md!} +{!models/dcim/devicetype.md!} +{!models/dcim/manufacturer.md!} --- @@ -30,11 +30,11 @@ Once component templates have been created, every new device that you create as !!! note Assignment of components from templates occurs only at the time of device creation. If you modify the templates of a device type, it will not affect devices which have already been created. However, you always have the option of adding, modifying, or deleting components on existing devices. -{!docs/models/dcim/consoleporttemplate.md!} -{!docs/models/dcim/consoleserverporttemplate.md!} -{!docs/models/dcim/powerporttemplate.md!} -{!docs/models/dcim/poweroutlettemplate.md!} -{!docs/models/dcim/interfacetemplate.md!} -{!docs/models/dcim/frontporttemplate.md!} -{!docs/models/dcim/rearporttemplate.md!} -{!docs/models/dcim/devicebaytemplate.md!} +{!models/dcim/consoleporttemplate.md!} +{!models/dcim/consoleserverporttemplate.md!} +{!models/dcim/powerporttemplate.md!} +{!models/dcim/poweroutlettemplate.md!} +{!models/dcim/interfacetemplate.md!} +{!models/dcim/frontporttemplate.md!} +{!models/dcim/rearporttemplate.md!} +{!models/dcim/devicebaytemplate.md!} diff --git a/docs/core-functionality/devices.md b/docs/core-functionality/devices.md index e05d6efd39..67e3612b94 100644 --- a/docs/core-functionality/devices.md +++ b/docs/core-functionality/devices.md @@ -1,8 +1,8 @@ # Devices and Cabling -{!docs/models/dcim/device.md!} -{!docs/models/dcim/devicerole.md!} -{!docs/models/dcim/platform.md!} +{!models/dcim/device.md!} +{!models/dcim/devicerole.md!} +{!models/dcim/platform.md!} --- @@ -10,20 +10,20 @@ Device components represent discrete objects within a device which are used to terminate cables, house child devices, or track resources. -{!docs/models/dcim/consoleport.md!} -{!docs/models/dcim/consoleserverport.md!} -{!docs/models/dcim/powerport.md!} -{!docs/models/dcim/poweroutlet.md!} -{!docs/models/dcim/interface.md!} -{!docs/models/dcim/frontport.md!} -{!docs/models/dcim/rearport.md!} -{!docs/models/dcim/devicebay.md!} -{!docs/models/dcim/inventoryitem.md!} +{!models/dcim/consoleport.md!} +{!models/dcim/consoleserverport.md!} +{!models/dcim/powerport.md!} +{!models/dcim/poweroutlet.md!} +{!models/dcim/interface.md!} +{!models/dcim/frontport.md!} +{!models/dcim/rearport.md!} +{!models/dcim/devicebay.md!} +{!models/dcim/inventoryitem.md!} --- -{!docs/models/dcim/virtualchassis.md!} +{!models/dcim/virtualchassis.md!} --- -{!docs/models/dcim/cable.md!} +{!models/dcim/cable.md!} diff --git a/docs/core-functionality/ipam.md b/docs/core-functionality/ipam.md index 00267dfe0f..c1e77069e2 100644 --- a/docs/core-functionality/ipam.md +++ b/docs/core-functionality/ipam.md @@ -1,19 +1,19 @@ # IP Address Management -{!docs/models/ipam/aggregate.md!} -{!docs/models/ipam/rir.md!} +{!models/ipam/aggregate.md!} +{!models/ipam/rir.md!} --- -{!docs/models/ipam/prefix.md!} -{!docs/models/ipam/role.md!} +{!models/ipam/prefix.md!} +{!models/ipam/role.md!} --- -{!docs/models/ipam/iprange.md!} -{!docs/models/ipam/ipaddress.md!} +{!models/ipam/iprange.md!} +{!models/ipam/ipaddress.md!} --- -{!docs/models/ipam/vrf.md!} -{!docs/models/ipam/routetarget.md!} +{!models/ipam/vrf.md!} +{!models/ipam/routetarget.md!} diff --git a/docs/core-functionality/power.md b/docs/core-functionality/power.md index 571109936a..bdefb2afd1 100644 --- a/docs/core-functionality/power.md +++ b/docs/core-functionality/power.md @@ -1,8 +1,8 @@ # Power Tracking -{!docs/models/dcim/powerpanel.md!} -{!docs/models/dcim/powerfeed.md!} +{!models/dcim/powerpanel.md!} +{!models/dcim/powerfeed.md!} # Example Power Topology -![Power distribution model](../../media/power_distribution.png) +![Power distribution model](/media/power_distribution.png) diff --git a/docs/core-functionality/services.md b/docs/core-functionality/services.md index 4d42560814..2e7aaf65a3 100644 --- a/docs/core-functionality/services.md +++ b/docs/core-functionality/services.md @@ -1,3 +1,3 @@ # Service Mapping -{!docs/models/ipam/service.md!} +{!models/ipam/service.md!} diff --git a/docs/core-functionality/sites-and-racks.md b/docs/core-functionality/sites-and-racks.md index 1b5ee3ad17..c78f2120ac 100644 --- a/docs/core-functionality/sites-and-racks.md +++ b/docs/core-functionality/sites-and-racks.md @@ -1,12 +1,12 @@ # Sites and Racks -{!docs/models/dcim/region.md!} -{!docs/models/dcim/sitegroup.md!} -{!docs/models/dcim/site.md!} -{!docs/models/dcim/location.md!} +{!models/dcim/region.md!} +{!models/dcim/sitegroup.md!} +{!models/dcim/site.md!} +{!models/dcim/location.md!} --- -{!docs/models/dcim/rack.md!} -{!docs/models/dcim/rackrole.md!} -{!docs/models/dcim/rackreservation.md!} +{!models/dcim/rack.md!} +{!models/dcim/rackrole.md!} +{!models/dcim/rackreservation.md!} diff --git a/docs/core-functionality/tenancy.md b/docs/core-functionality/tenancy.md index 5409556984..fbe1ea8b9c 100644 --- a/docs/core-functionality/tenancy.md +++ b/docs/core-functionality/tenancy.md @@ -1,4 +1,4 @@ # Tenancy Assignment -{!docs/models/tenancy/tenant.md!} -{!docs/models/tenancy/tenantgroup.md!} +{!models/tenancy/tenant.md!} +{!models/tenancy/tenantgroup.md!} diff --git a/docs/core-functionality/virtualization.md b/docs/core-functionality/virtualization.md index f406a59f31..220030ab20 100644 --- a/docs/core-functionality/virtualization.md +++ b/docs/core-functionality/virtualization.md @@ -1,10 +1,10 @@ # Virtualization -{!docs/models/virtualization/cluster.md!} -{!docs/models/virtualization/clustertype.md!} -{!docs/models/virtualization/clustergroup.md!} +{!models/virtualization/cluster.md!} +{!models/virtualization/clustertype.md!} +{!models/virtualization/clustergroup.md!} --- -{!docs/models/virtualization/virtualmachine.md!} -{!docs/models/virtualization/vminterface.md!} +{!models/virtualization/virtualmachine.md!} +{!models/virtualization/vminterface.md!} diff --git a/docs/core-functionality/vlans.md b/docs/core-functionality/vlans.md index cf1c73fe3f..d691287650 100644 --- a/docs/core-functionality/vlans.md +++ b/docs/core-functionality/vlans.md @@ -1,4 +1,4 @@ # VLAN Management -{!docs/models/ipam/vlan.md!} -{!docs/models/ipam/vlangroup.md!} +{!models/ipam/vlan.md!} +{!models/ipam/vlangroup.md!} diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md index a27bcab83c..252e65f902 100644 --- a/docs/customization/custom-scripts.md +++ b/docs/customization/custom-scripts.md @@ -226,7 +226,7 @@ An IPv4 or IPv6 network with a mask. Returns a `netaddr.IPNetwork` object. Two a !!! note To run a custom script, a user must be assigned the `extras.run_script` permission. This is achieved by assigning the user (or group) a permission on the Script object and specifying the `run` action in the admin UI as shown below. - ![Adding the run action to a permission](../../media/admin_ui_run_permission.png) + ![Adding the run action to a permission](/media/admin_ui_run_permission.png) ### Via the Web UI diff --git a/docs/customization/reports.md b/docs/customization/reports.md index 0d75abd219..2fead68ec2 100644 --- a/docs/customization/reports.md +++ b/docs/customization/reports.md @@ -104,7 +104,7 @@ Once you have created a report, it will appear in the reports list. Initially, r !!! note To run a report, a user must be assigned the `extras.run_report` permission. This is achieved by assigning the user (or group) a permission on the Report object and specifying the `run` action in the admin UI as shown below. - ![Adding the run action to a permission](../../media/admin_ui_run_permission.png) + ![Adding the run action to a permission](/media/admin_ui_run_permission.png) ### Via the Web UI diff --git a/docs/models/dcim/cable.md b/docs/models/dcim/cable.md index 753ab6f7fe..18ac1002e2 100644 --- a/docs/models/dcim/cable.md +++ b/docs/models/dcim/cable.md @@ -25,7 +25,7 @@ A cable may be traced from either of its endpoints by clicking the "trace" butto In the example below, three individual cables comprise a path between devices A and D: -![Cable path](../../media/models/dcim_cable_trace.png) +![Cable path](/media/models/dcim_cable_trace.png) Traced from Interface 1 on Device A, NetBox will show the following path: diff --git a/docs/rest-api/authentication.md b/docs/rest-api/authentication.md index 93c1ce3033..1571f15faf 100644 --- a/docs/rest-api/authentication.md +++ b/docs/rest-api/authentication.md @@ -2,7 +2,7 @@ The NetBox REST API primarily employs token-based authentication. For convenience, cookie-based authentication can also be used when navigating the browsable API. -{!docs/models/users/token.md!} +{!models/users/token.md!} ## Authenticating to the API diff --git a/mkdocs.yml b/mkdocs.yml index f4c0cb1378..7244c36d6f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,9 +3,6 @@ site_dir: netbox/project-static/docs site_url: https://netbox.readthedocs.io/ repo_name: netbox-community/netbox repo_url: https://github.com/netbox-community/netbox -python: - install: - - requirements: docs/requirements.txt theme: name: material icon: @@ -24,13 +21,14 @@ extra: - icon: fontawesome/brands/github link: https://github.com/netbox-community/netbox - icon: fontawesome/brands/slack - link: https://slack.netbox.dev + link: https://netdev.chat/ extra_css: - extra.css markdown_extensions: - admonition - attr_list - markdown_include.include: + base_path: 'docs/' headingOffset: 1 - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji