8000 bug: `show_docstring_attributes: false` is non-functional · Issue #197 · mkdocstrings/python · GitHub
[go: up one dir, main page]

Skip to content
bug: show_docstring_attributes: false is non-functional #197
Closed as not planned
@Archmonger

Description

@Archmonger

Description of the bug

To Reproduce

git clone https://github.com/reactive-python/reactpy-router/
cd reactpy-router
python -m venv .venv
.venv/bin/activate
pip install -r requirements.txt
cd docs

edit mkdocs.yml to enable show_docstring_attributes: false

mkdocs serve

Open the preview browser and navigate to any location where docstring attribute exist, such as Reference > Types

Watch as all the Attributes sections still exist.

Full traceback

Full traceback N/A

Expected behavior

Any section containing Attributes: should be removed when this flag is enabled.

Environment information

  • System: Windows-11-10.0.22631-SP0
  • Python: cpython 3.12.0b4 (C:\Users\Username\Repositories\reactpy-router.venv\Scripts\python.exe)
  • Environment variables:
  • Installed packages:
    • mkdocs v1.6.1
    • mkdocstrings v0.26.2
    • mkdocstrings-python v1.12.1
    • griffe v1.4.1

Additional context

Was attempting to use this to hide the docstring attributes.

To be honest I would have preferred to hide the section highlighted in red. There doesn't appear to be a convenient way of doing that at the moment.

image

Metadata

Metadata

Assignees

Labels

unconfirmedThis bug was not reproduced yet

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    0