Skip to content

Fix class attribute documentation generation #1078

@coruscating

Description

@coruscating

The default class template behavior for documenting attributes needs to be updated. For example, when docstrings are written for class variables, the docs render both the docstring content and the variables as links to empty pages:

image

We should enforce documenting these variables in docstrings and not render them in the attributes section. The solution in #983 is to skip them manually in conf.py, but there should be a way to automatically ignore them.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions