Data plane packages should document inherited members (Azure#33666)

danieljurek · web-flow · commit 6aa171f81c01 · 2023-12-28T10:55:57.000-08:00
diff --git a/eng/scripts/docs/Docs-Onboarding.ps1 b/eng/scripts/docs/Docs-Onboarding.ps1
@@ -18,6 +18,12 @@ function Set-python-DocsPackageOnboarding($moniker, $metadata, $docRepoLocation,
             exclude_path = @("test*","example*","sample*","doc*")
         }
 
+        # Data-plane packages (not mgmt packages, and not manually added '00`
+        # packages) should document inherited members
+        if ($package.Name -notlike 'azure-mgmt-*' -and $package.Name -notlike '*-00-*') {
+            $packageSpec['extension_config'] = @{ 'autodoc_default_options' = @{ 'inherited-members' = 1 } }
+        }
+
         if ($packageSourceOverride) {
             $packageSpec['package_info']['extra_index_url'] = $packageSourceOverride
         }

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,12 @@ function Set-python-DocsPackageOnboarding($moniker, $metadata, $docRepoLocation,`
`18`	`18`	`exclude_path = @("test","example","sample","doc")`
`19`	`19`	`}`
`20`	`20`
	`21`	+ # Data-plane packages (not mgmt packages, and not manually added '00`
	`22`	`+ # packages) should document inherited members`
	`23`	`+ if ($package.Name -notlike 'azure-mgmt-' -and $package.Name -notlike '-00-*') {`
	`24`	`+ $packageSpec['extension_config'] = @{ 'autodoc_default_options' = @{ 'inherited-members' = 1 } }`
	`25`	`+ }`
	`26`	`+`
`21`	`27`	`if ($packageSourceOverride) {`
`22`	`28`	`$packageSpec['package_info']['extra_index_url'] = $packageSourceOverride`
`23`	`29`	`}`