Skip to content

Commit

Permalink
add docs url
Browse files Browse the repository at this point in the history
  • Loading branch information
gsnider2195 committed Oct 16, 2024
1 parent a3acdd4 commit ed0194c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Nautobot Plugin Nornir

<p align="center">
<img src="https://raw.githubusercontent.com/nautobot/nautobot-app-nornir/develop/docs/images/icon-nautobot-plugin-nornir.png" class="logo" height="200px">
<img src="https://raw.githubusercontent.com/nautobot/nautobot-app-nornir/develop/docs/images/icon-NautobotPluginNornir.png" class="logo" height="200px">
<br>
<a href="https://github.com/nautobot/nautobot-app-nornir/actions"><img src="https://github.com/nautobot/nautobot-app-nornir/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://docs.nautobot.com/projects/plugin-nornir/en/latest/"><img src="https://readthedocs.org/projects/nautobot-plugin-nornir/badge/"></a>
Expand Down
1 change: 1 addition & 0 deletions nautobot_plugin_nornir/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ class NautobotPluginNornirConfig(NautobotAppConfig):
max_version = "2.9999"
default_settings = {}
caching_config = {}
docs_view_name = "plugins:nautobot_plugin_nornir:docs"

def ready(self):
"""Check for accidental legacy configurations."""
Expand Down
9 changes: 9 additions & 0 deletions nautobot_plugin_nornir/urls.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
"""Django urlpatterns declaration for nautobot_plugin_nornir app."""

from django.templatetags.static import static
from django.urls import path
from django.views.generic import RedirectView

urlpatterns = [
path("docs/", RedirectView.as_view(url=static("nautobot_plugin_nornir/docs/index.html")), name="docs"),
]

0 comments on commit ed0194c

Please sign in to comment.