Add example of class attributes (#601)

We've encountered this in Qiskit documentation. We want them here to have an example of how Sphinx renders class attributes. These are attributes specified in the class docstring with the `Attributes` caption. They are different than properties.
Qiskit · Mar 26, 2024 · 4606dfd · 4606dfd
1 parent a4cbd3b
commit 4606dfd
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/example_docs/api_example/electron.py b/example_docs/api_example/electron.py
@@ -14,6 +14,11 @@ class Electron:
             from api_example import Electron
 
             ELECTRON = Electron(size="2GB", name="QuantumComputing")
+
+    Attributes:
+
+        size (str): How big the Electron is.
+        name: What the Electron is called.
     """
 
     # Regression test for https://github.com/Qiskit/qiskit_sphinx_theme/issues/50.

diff --git a/tests/js/tests.js-snapshots/api-docs-class-page-1-linux.png b/tests/js/tests.js-snapshots/api-docs-class-page-1-linux.png