Merge pull request #75 from nautobot/shooks-docs-update

Documentation refactor

.readthedocs.yml

@@ -0,0 +1,22 @@
+---
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python in the build environment.
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+mkdocs:
+  configuration: "mkdocs.yml"
+  fail_on_warning: true
+
+# Use our docs/requirements.txt during installation.
+python:
+  install:
+    - requirements: "docs/requirements.txt"

README.md

@@ -1,31 +1,36 @@
-# nornir_nautobot
+# Nornir Nautobot
+[![GitHub Actions](https://github.com/nautobot/nornir-nautobot/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/nautobot/nornir-nautobot/actions)
+[![PyPI Version](https://img.shields.io/pypi/v/nornir-nautobot)](https://pypi.org/project/nornir-nautobot/)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/nornir-nautobot)](https://pypi.org/project/nornir-nautobot/)
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-
-## Build Status
-
-| Branch  | Status                                                                                                                               |
-| ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
-| develop | [![CI](https://github.com/nautobot/nornir-nautobot/actions/workflows/ci.yml/badge.svg)](https://github.com/nautobot/nornir-nautobot/actions/workflows/ci.yml) |
-## Overview
-
-The nornir_nautobot project intends to solve two primary use cases.
+Nornir-Nautobot is a set of utilities to help interact with Nautobot via Nornir. The nornir_nautobot project intends to solve two primary use cases.
 
 * Providing a Nornir inventory that leverages Nautobot's API.
 * A set of opinionated Nornir plugins.
 
 The set of plugins intend to provide mechanisms to include common networking workflows that will help enable network automation. As an example, there are method to get configurations or test network connectivity. Over time this will include functions to perform actions such as get vlans, neighbors, protocols, etc.
 
-## Getting Started
+# Installation
+
+To install Nornir Nautobot install via Python PIP:
 
 ```shell
 pip install nornir-nautobot
 ```
+## Inventory
+
+The inventory plugin is used to gather inventory from a Nautobot instance. This queries the DCIM endpoint to gather information about the devices.  
+
+[Inventory](https://docs.nautobot.com/projects/nornir-nautobot/en/latest/inventory/inventory/)
+
+## Processor Plugin
+
+This is an opinionated plugin to help with network automation workflows with Nautobot.
 
-## Documentation Link
+[Processor Plugin](https://docs.nautobot.com/projects/nornir-nautobot/en/latest/processor/processor/)
 
-The documentation can be found on [Read the Docs](https://nornir-nautobot.readthedocs.io/en/latest/)
+## Task Plugin
 
-## Nautobot
+The task plugin helps with dispatching specific functions with multiple underlying OS.
 
-Nautobot documentation is available at [Nautobot Read the Docs](https://nautobot.readthedocs.io/en/latest/)
+[Task Plugin](https://docs.nautobot.com/projects/nornir-nautobot/en/latest/task/task/)

docs/assets/extra.css

@@ -0,0 +1,122 @@
+:root>* {
+    --md-accent-fg-color: #ff8504;
+    --md-primary-fg-color: #ff8504;
+    --md-typeset-a-color: #0097ff;
+}
+
+[data-md-color-scheme="slate"] {
+    --md-default-bg-color: hsla(var(--md-hue), 0%, 15%, 1);
+    --md-typeset-a-color: #0097ff;
+}
+
+/* Accessibility: Increase fonts for dark theme */
+[data-md-color-scheme="slate"] .md-typeset {
+    font-size: 0.9rem;
+}
+
+[data-md-color-scheme="slate"] .md-typeset table:not([class]) {
+    font-size: 0.7rem;
+}
+
+.md-tabs__link {
+    font-size: 0.8rem;
+}
+
+.md-tabs__link--active {
+    color: var(--md-primary-fg-color);
+}
+
+.md-header__button.md-logo :is(img, svg) {
+    height: 2rem;
+}
+
+.md-header__button.md-logo :-webkit-any(img, svg) {
+    height: 2rem;
+}
+
+.md-header__title {
+    font-size: 1.2rem;
+}
+
+img.logo {
+    height: 100px;
+}
+
+img.copyright-logo {
+    height: 24px;
+    vertical-align: middle;
+}
+
+[data-md-color-primary=black] .md-header {
+    background-color: #212121;
+}
+
+@media screen and (min-width: 76.25em) {
+    [data-md-color-primary=black] .md-tabs {
+        background-color: #212121;
+    }
+}
+
+/* mkdocs-version-annotations material theme customizations */
+:root {
+    /* Icon for "version-added" admonition: Material Design Icons "plus-box-outline" */
+    --md-admonition-icon--version-added: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 19V5H5v14h14m0-16a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h14m-8 4h2v4h4v2h-4v4h-2v-4H7v-2h4V7Z"/></svg>');
+    /* Icon for "version-changed" admonition: Material Design Icons "delta" */
+    --md-admonition-icon--version-changed: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7.77 18.39 18H5.61L12 7.77M12 4 2 20h20"/></svg>');
+    /* Icon for "version-removed" admonition: Material Design Icons "minus-circle-outline" */
+    --md-admonition-icon--version-removed: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2M7 13h10v-2H7"/></svg>');
+}
+
+/* "version-added" admonition in green */
+.md-typeset .admonition.version-added,
+.md-typeset details.version-added {
+    border-color: rgb(0, 200, 83);
+}
+
+.md-typeset .version-added>.admonition-title,
+.md-typeset .version-added>summary {
+    background-color: rgba(0, 200, 83, .1);
+}
+
+.md-typeset .version-added>.admonition-title::before,
+.md-typeset .version-added>summary::before {
+    background-color: rgb(0, 200, 83);
+    -webkit-mask-image: var(--md-admonition-icon--version-added);
+    mask-image: var(--md-admonition-icon--version-added);
+}
+
+/* "version-changed" admonition in orange */
+.md-typeset .admonition.version-changed,
+.md-typeset details.version-changed {
+    border-color: rgb(255, 145, 0);
+}
+
+.md-typeset .version-changed>.admonition-title,
+.md-typeset .version-changed>summary {
+    background-color: rgba(255, 145, 0, .1);
+}
+
+.md-typeset .version-changed>.admonition-title::before,
+.md-typeset .version-changed>summary::before {
+    background-color: rgb(255, 145, 0);
+    -webkit-mask-image: var(--md-admonition-icon--version-changed);
+    mask-image: var(--md-admonition-icon--version-changed);
+}
+
+/* "version-removed" admonition in red */
+.md-typeset .admonition.version-removed,
+.md-typeset details.version-removed {
+    border-color: rgb(255, 82, 82);
+}
+
+.md-typeset .version-removed>.admonition-title,
+.md-typeset .version-removed>summary {
+    background-color: rgba(255, 82, 82, .1);
+}
+
+.md-typeset .version-removed>.admonition-title::before,
+.md-typeset .version-removed>summary::before {
+    background-color: rgb(255, 82, 82);
+    -webkit-mask-image: var(--md-admonition-icon--version-removed);
+    mask-image: var(--md-admonition-icon--version-removed);
+}