mirror of
				https://github.com/netbox-community/netbox.git
				synced 2024-05-10 07:54:54 +00:00 
			
		
		
		
	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>
This commit is contained in:
		@@ -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.
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.ColorField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.CommentField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.JSONField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.MACAddressField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.SlugField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
## Choice Fields
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.ChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.MultipleChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
## Dynamic Object Fields
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.DynamicModelChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.DynamicModelMultipleChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
## Content Type Fields
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.ContentTypeChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.ContentTypeMultipleChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
## CSV Import Fields
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.CSVChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.CSVMultipleChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.CSVModelChoiceField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.CSVContentTypeField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: utilities.forms.CSVMultipleContentTypeField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 
 | 
			
		||||
@@ -32,11 +32,11 @@ schema = MyQuery
 | 
			
		||||
NetBox provides two object type classes for use by plugins.
 | 
			
		||||
 | 
			
		||||
::: netbox.graphql.types.BaseObjectType
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.graphql.types.NetBoxObjectType
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
## 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.graphql.fields.ObjectField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.graphql.fields.ObjectListField
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 
 | 
			
		||||
@@ -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`.
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.BooleanColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.ChoiceFieldColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.ColorColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.ColoredLabelColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.ContentTypeColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.ContentTypesColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.MarkdownColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.TagColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.tables.TemplateColumn
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - __init__
 | 
			
		||||
 
 | 
			
		||||
@@ -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.ObjectView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - get_object
 | 
			
		||||
        - get_template_name
 | 
			
		||||
 | 
			
		||||
::: netbox.views.generic.ObjectEditView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - get_object
 | 
			
		||||
        - alter_object
 | 
			
		||||
 | 
			
		||||
::: netbox.views.generic.ObjectDeleteView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - get_object
 | 
			
		||||
 | 
			
		||||
::: netbox.views.generic.ObjectChildrenView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - get_children
 | 
			
		||||
        - 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.ObjectListView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - get_table
 | 
			
		||||
        - export_table
 | 
			
		||||
        - export_template
 | 
			
		||||
 | 
			
		||||
::: netbox.views.generic.BulkImportView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.views.generic.BulkEditView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members: false
 | 
			
		||||
 | 
			
		||||
::: netbox.views.generic.BulkDeleteView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - 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.
 | 
			
		||||
 | 
			
		||||
::: netbox.views.generic.ObjectChangeLogView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - get_form
 | 
			
		||||
 | 
			
		||||
::: netbox.views.generic.ObjectJournalView
 | 
			
		||||
    selection:
 | 
			
		||||
    options:
 | 
			
		||||
      members:
 | 
			
		||||
        - get_form
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -30,7 +30,7 @@ plugins:
 | 
			
		||||
            - os.chdir('netbox/')
 | 
			
		||||
            - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netbox.settings")
 | 
			
		||||
            - django.setup()
 | 
			
		||||
          rendering:
 | 
			
		||||
          options:
 | 
			
		||||
            heading_level: 3
 | 
			
		||||
            members_order: source
 | 
			
		||||
            show_root_heading: true
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user