File tree Expand file tree Collapse file tree 3 files changed +61
-63
lines changed
src/mkdocstrings_handlers/python/_internal Expand file tree Collapse file tree 3 files changed +61
-63
lines changed Original file line number Diff line number Diff line change @@ -494,3 +494,63 @@ def some_function():
494494<p>Docstring of the function.</p>
495495////
496496///
497+
498+ [](){#option-skip_local_inventory}
499+ # # `skip_local_inventory`
500+
501+ - **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
502+ <!-- - **:octicons-project-template-24 : Template :material-null:** (N/A) -->
503+
504+ Whether to not give objects local inventory entries.
505+
506+ With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local.
507+
508+ ` ` ` yaml title="in mkdocs.yml (global configuration)"
509+ plugins:
510+ - mkdocstrings:
511+ handlers:
512+ python:
513+ options:
514+ skip_local_inventory: false
515+ ` ` `
516+
517+ ` ` ` md title="or in docs/some_page.md (local configuration)"
518+ ::: path.to.module
519+ options:
520+ skip_local_inventory: true
521+ ` ` `
522+
523+ /// admonition | Preview
524+ type : preview
525+
526+
527+ //// tab | Without `skip_local_inventory`
528+
529+ ` ` ` md exec="on"
530+ ::: bisect.bisect_left
531+ options:
532+ heading_level: 3
533+ skip_local_inventory: false
534+ show_docstring_description: false
535+ ` ` `
536+
537+ Notice how [`bisect.bisect_left`][] now points to the section above.
538+
539+ ////
540+
541+ //// tab | With `skip_local_inventory`
542+
543+ ` ` ` md exec="on"
544+ ::: bisect.bisect_right
545+ inventories:
546+ - https://docs.python.org/3/objects.inv
547+ options:
548+ heading_level: 3
549+ skip_local_inventory: true
550+ show_docstring_description: false
551+ ` ` `
552+
553+ Notice how [`bisect.bisect_right`][] points to the original Python documentation.
554+
555+ ////
556+ ///
Original file line number Diff line number Diff line change @@ -664,68 +664,6 @@ plugins:
664664////
665665///
666666
667-
668- [](){#option-skip_local_inventory}
669- # # `skip_local_inventory`
670-
671- - **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
672- <!-- - **:octicons-project-template-24 : Template :material-null:** (N/A) -->
673-
674- Whether to not give objects local inventory entries.
675-
676- With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local.
677-
678- ` ` ` yaml title="in mkdocs.yml (global configuration)"
679- plugins:
680- - mkdocstrings:
681- handlers:
682- python:
683- options:
684- skip_local_inventory: false
685- ` ` `
686-
687- ` ` ` md title="or in docs/some_page.md (local configuration)"
688- ::: path.to.module
689- options:
690- skip_local_inventory: true
691- ` ` `
692-
693- /// admonition | Preview
694- type : preview
695-
696-
697- //// tab | Without `skip_local_inventory`
698-
699- ` ` ` md exec="on"
700- ::: bisect.bisect_left
701- options:
702- heading_level: 3
703- skip_local_inventory: false
704- show_docstring_description: false
705- ` ` `
706-
707- Notice how [`bisect.bisect_left`][] now points to the section above.
708-
709- ////
710-
711- //// tab | With `skip_local_inventory`
712-
713- ` ` ` md exec="on"
714- ::: bisect.bisect_right
715- inventories:
716- - https://docs.python.org/3/objects.inv
717- options:
718- heading_level: 3
719- skip_local_inventory: true
720- show_docstring_description: false
721- ` ` `
722-
723- Notice how [`bisect.bisect_right`][] points to the original Python documentation.
724-
725- ////
726-
727- ///
728-
729667[](){#option-toc_label}
730668# # `toc_label`
731669
Original file line number Diff line number Diff line change @@ -868,7 +868,7 @@ class PythonInputOptions:
868868 skip_local_inventory : Annotated [
869869 bool ,
870870 _Field (
871- group = "headings " ,
871+ group = "general " ,
872872 description = "Whether to not give objects local inventory entries." ,
873873 ),
874874 ] = False
You can’t perform that action at this time.
0 commit comments