qiskit-community / qiskit-experiments

Qiskit Experiments
https://qiskit-community.github.io/qiskit-experiments/
Apache License 2.0
156 stars 126 forks source link

Fix class attribute documentation generation #1078

Open coruscating opened 1 year ago

coruscating commented 1 year ago

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.

nitin-pandita commented 1 year ago

I would love to contribute , can you assign this to me @coruscating

coruscating commented 1 year ago

@nitin-pandita Have you started working on this? Happy to assign it to you if you're still interested.

Another issue that needs fixing is classes that inherit from a built-in class, for example dict, renders built-in methods that are not helpful: https://qiskit.org/ecosystem/experiments/stubs/qiskit_experiments.visualization.PlotStyle.html

Ideally these should not be rendered.

nitin-pandita commented 1 year ago

@nitin-pandita Have you started working on this? Happy to assign it to you if you're still interested.

Another issue that needs fixing is classes that inherit from a built-in class, for example dict, renders built-in methods that are not helpful: https://qiskit.org/ecosystem/experiments/stubs/qiskit_experiments.visualization.PlotStyle.html

Ideally these should not be rendered.

I would love to work on it, just need a time extension , busy with my semester exams. Hope you understand

coruscating commented 1 year ago

@nitin-pandita No worries, there's no rush.

nitin-pandita commented 1 year ago

@nitin-pandita No worries, there's no rush.

Thank you, i will try my best to complete it as soon as possible