File tree Expand file tree Collapse file tree 3 files changed +44
-45
lines changed
src/mkdocstrings_handlers/python/_internal Expand file tree Collapse file tree 3 files changed +44
-45
lines changed Original file line number Diff line number Diff line change @@ -519,50 +519,6 @@ def function_d():
519
519
////
520
520
///
521
521
522
-
523
- [](){#option-show_attribute_values}
524
- # # `show_attribute_values`
525
-
526
- - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
527
- <!-- - **:octicons-project-template-24 : Template :material-null:** (contained in [`class.html`][class template]) -->
528
-
529
- Show initial values of attributes in classes.
530
-
531
- ` ` ` yaml title="in mkdocs.yml (global configuration)"
532
- plugins:
533
- - mkdocstrings:
534
- handlers:
535
- python:
536
- options:
537
- show_attribute_values: true
538
- ` ` `
539
-
540
- ` ` ` md title="or in docs/some_page.md (local configuration)"
541
- ::: path.to.object
542
- options:
543
- show_attribute_values: true
544
- ` ` `
545
-
546
- ` ` ` python title="package/module.py"
547
- class SomeClass:
548
- def __init__(self):
549
- self.some_attr = 1
550
- ` ` `
551
-
552
- /// admonition | Preview
553
- type : preview
554
-
555
- //// tab | With attribute values visible
556
- <h2><code>SomeClass</code></h2>
557
- <p>some_attr = 1</p>
558
- ////
559
-
560
- //// tab | With attribute values hidden
561
- <h2><code>SomeClass</code></h2>
562
- <p>some_attr</p>
563
- ////
564
- ///
565
-
566
522
[](){#option-show_submodules}
567
523
# # `show_submodules`
568
524
Original file line number Diff line number Diff line change @@ -483,6 +483,49 @@ function(param1, param2=None)
483
483
////
484
484
///
485
485
486
+ [](){#option-show_attribute_values}
487
+ # # `show_attribute_values`
488
+
489
+ - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
490
+ <!-- - **:octicons-project-template-24 : Template :material-null:** (contained in [`class.html`][class template]) -->
491
+
492
+ Show initial values of attributes in classes.
493
+
494
+ ` ` ` yaml title="in mkdocs.yml (global configuration)"
495
+ plugins:
496
+ - mkdocstrings:
497
+ handlers:
498
+ python:
499
+ options:
500
+ show_attribute_values: true
501
+ ` ` `
502
+
503
+ ` ` ` md title="or in docs/some_page.md (local configuration)"
504
+ ::: path.to.object
505
+ options:
506
+ show_attribute_values: true
507
+ ` ` `
508
+
509
+ ` ` ` python title="package/module.py"
510
+ class SomeClass:
511
+ def __init__(self):
512
+ self.some_attr = 1
513
+ ` ` `
514
+
515
+ /// admonition | Preview
516
+ type : preview
517
+
518
+ //// tab | With attribute values visible
519
+ <h2><code>SomeClass</code></h2>
520
+ <p>some_attr = 1</p>
521
+ ////
522
+
523
+ //// tab | With attribute values hidden
524
+ <h2><code>SomeClass</code></h2>
525
+ <p>some_attr</p>
526
+ ////
527
+ ///
528
+
486
529
[](){#option-show_overloads}
487
530
# # `show_overloads`
488
531
Original file line number Diff line number Diff line change @@ -625,7 +625,7 @@ class PythonInputOptions:
625
625
show_attribute_values : Annotated [
626
626
bool ,
627
627
_Field (
628
- group = "members " ,
628
+ group = "signatures " ,
629
629
description = "Show initial values of attributes in classes." ,
630
630
),
631
631
] = True
You can’t perform that action at this time.
0 commit comments