Explorar el Código

10571 replace deprecated mkdoc settings (#10622)

* 10571 replace deprecated mkdoc settings

* Omit landing page from docs nav menu

Co-authored-by: jeremystretch <jstretch@ns1.com>
Arthur Hanson hace 3 años
padre
commit
bb150379a2

+ 16 - 16
docs/plugins/development/forms.md

@@ -144,73 +144,73 @@ class MyModelFilterForm(NetBoxModelFilterSetForm):
 In addition to the [form fields provided by Django](https://docs.djangoproject.com/en/stable/ref/forms/fields/), NetBox provides several field classes for use within forms to handle specific types of data. These can be imported from `utilities.forms.fields` and are documented below.
 In addition to the [form fields provided by Django](https://docs.djangoproject.com/en/stable/ref/forms/fields/), NetBox provides several field classes for use within forms to handle specific types of data. These can be imported from `utilities.forms.fields` and are documented below.
 
 
 ::: utilities.forms.ColorField
 ::: utilities.forms.ColorField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.CommentField
 ::: utilities.forms.CommentField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.JSONField
 ::: utilities.forms.JSONField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.MACAddressField
 ::: utilities.forms.MACAddressField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.SlugField
 ::: utilities.forms.SlugField
-    selection:
+    options:
       members: false
       members: false
 
 
 ## Choice Fields
 ## Choice Fields
 
 
 ::: utilities.forms.ChoiceField
 ::: utilities.forms.ChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.MultipleChoiceField
 ::: utilities.forms.MultipleChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ## Dynamic Object Fields
 ## Dynamic Object Fields
 
 
 ::: utilities.forms.DynamicModelChoiceField
 ::: utilities.forms.DynamicModelChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.DynamicModelMultipleChoiceField
 ::: utilities.forms.DynamicModelMultipleChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ## Content Type Fields
 ## Content Type Fields
 
 
 ::: utilities.forms.ContentTypeChoiceField
 ::: utilities.forms.ContentTypeChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.ContentTypeMultipleChoiceField
 ::: utilities.forms.ContentTypeMultipleChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ## CSV Import Fields
 ## CSV Import Fields
 
 
 ::: utilities.forms.CSVChoiceField
 ::: utilities.forms.CSVChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.CSVMultipleChoiceField
 ::: utilities.forms.CSVMultipleChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.CSVModelChoiceField
 ::: utilities.forms.CSVModelChoiceField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.CSVContentTypeField
 ::: utilities.forms.CSVContentTypeField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: utilities.forms.CSVMultipleContentTypeField
 ::: utilities.forms.CSVMultipleContentTypeField
-    selection:
+    options:
       members: false
       members: false

+ 4 - 4
docs/plugins/development/graphql-api.md

@@ -32,11 +32,11 @@ schema = MyQuery
 NetBox provides two object type classes for use by plugins.
 NetBox provides two object type classes for use by plugins.
 
 
 ::: netbox.graphql.types.BaseObjectType
 ::: netbox.graphql.types.BaseObjectType
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.graphql.types.NetBoxObjectType
 ::: netbox.graphql.types.NetBoxObjectType
-    selection:
+    options:
       members: false
       members: false
 
 
 ## GraphQL Fields
 ## GraphQL Fields
@@ -44,9 +44,9 @@ NetBox provides two object type classes for use by plugins.
 NetBox provides two field classes for use by plugins.
 NetBox provides two field classes for use by plugins.
 
 
 ::: netbox.graphql.fields.ObjectField
 ::: netbox.graphql.fields.ObjectField
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.graphql.fields.ObjectListField
 ::: netbox.graphql.fields.ObjectListField
-    selection:
+    options:
       members: false
       members: false

+ 9 - 9
docs/plugins/development/tables.md

@@ -52,38 +52,38 @@ This will automatically apply any user-specific preferences for the table. (If u
 The table column classes listed below are supported for use in plugins. These classes can be imported from `netbox.tables.columns`.
 The table column classes listed below are supported for use in plugins. These classes can be imported from `netbox.tables.columns`.
 
 
 ::: netbox.tables.BooleanColumn
 ::: netbox.tables.BooleanColumn
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.tables.ChoiceFieldColumn
 ::: netbox.tables.ChoiceFieldColumn
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.tables.ColorColumn
 ::: netbox.tables.ColorColumn
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.tables.ColoredLabelColumn
 ::: netbox.tables.ColoredLabelColumn
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.tables.ContentTypeColumn
 ::: netbox.tables.ContentTypeColumn
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.tables.ContentTypesColumn
 ::: netbox.tables.ContentTypesColumn
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.tables.MarkdownColumn
 ::: netbox.tables.MarkdownColumn
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.tables.TagColumn
 ::: netbox.tables.TagColumn
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.tables.TemplateColumn
 ::: netbox.tables.TemplateColumn
-    selection:
+    options:
       members:
       members:
         - __init__
         - __init__

+ 10 - 10
docs/plugins/development/views.md

@@ -84,24 +84,24 @@ Below are the class definitions for NetBox's object views. These views handle CR
 ::: netbox.views.generic.base.BaseObjectView
 ::: netbox.views.generic.base.BaseObjectView
 
 
 ::: netbox.views.generic.ObjectView
 ::: netbox.views.generic.ObjectView
-    selection:
+    options:
       members:
       members:
         - get_object
         - get_object
         - get_template_name
         - get_template_name
 
 
 ::: netbox.views.generic.ObjectEditView
 ::: netbox.views.generic.ObjectEditView
-    selection:
+    options:
       members:
       members:
         - get_object
         - get_object
         - alter_object
         - alter_object
 
 
 ::: netbox.views.generic.ObjectDeleteView
 ::: netbox.views.generic.ObjectDeleteView
-    selection:
+    options:
       members:
       members:
         - get_object
         - get_object
 
 
 ::: netbox.views.generic.ObjectChildrenView
 ::: netbox.views.generic.ObjectChildrenView
-    selection:
+    options:
       members:
       members:
         - get_children
         - get_children
         - prep_table_data
         - prep_table_data
@@ -113,22 +113,22 @@ Below are the class definitions for NetBox's multi-object views. These views han
 ::: netbox.views.generic.base.BaseMultiObjectView
 ::: netbox.views.generic.base.BaseMultiObjectView
 
 
 ::: netbox.views.generic.ObjectListView
 ::: netbox.views.generic.ObjectListView
-    selection:
+    options:
       members:
       members:
         - get_table
         - get_table
         - export_table
         - export_table
         - export_template
         - export_template
 
 
 ::: netbox.views.generic.BulkImportView
 ::: netbox.views.generic.BulkImportView
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.views.generic.BulkEditView
 ::: netbox.views.generic.BulkEditView
-    selection:
+    options:
       members: false
       members: false
 
 
 ::: netbox.views.generic.BulkDeleteView
 ::: netbox.views.generic.BulkDeleteView
-    selection:
+    options:
       members:
       members:
         - get_form
         - get_form
 
 
@@ -137,12 +137,12 @@ Below are the class definitions for NetBox's multi-object views. These views han
 These views are provided to enable or enhance certain NetBox model features, such as change logging or journaling. These typically do not need to be subclassed: They can be used directly e.g. in a URL path.
 These views are provided to enable or enhance certain NetBox model features, such as change logging or journaling. These typically do not need to be subclassed: They can be used directly e.g. in a URL path.
 
 
 ::: netbox.views.generic.ObjectChangeLogView
 ::: netbox.views.generic.ObjectChangeLogView
-    selection:
+    options:
       members:
       members:
         - get_form
         - get_form
 
 
 ::: netbox.views.generic.ObjectJournalView
 ::: netbox.views.generic.ObjectJournalView
-    selection:
+    options:
       members:
       members:
         - get_form
         - get_form
 
 

+ 1 - 1
mkdocs.yml

@@ -30,7 +30,7 @@ plugins:
             - os.chdir('netbox/')
             - os.chdir('netbox/')
             - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
             - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
             - django.setup()
             - django.setup()
-          rendering:
+          options:
             heading_level: 3
             heading_level: 3
             members_order: source
             members_order: source
             show_root_heading: true
             show_root_heading: true