From b78bfd18496d7480eb5a5d244a526c3e1a04f132 Mon Sep 17 00:00:00 2001
From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Date: Tue, 26 Mar 2024 13:07:26 -0400
Subject: [PATCH] Add example of class attributes to integration test (#1097)
These render worse than we realized. This PR creates a baseline so that
we can see how our changes improve things over time.
See https://github.com/Qiskit/documentation/issues/1098 for the tracking
issue.
---
.../conversionPipeline.test.ts.snap | 16 +++++++++++++
.../testdata/qiskit-sphinx-theme/objects.inv | Bin 2499 -> 2530 bytes
.../stubs/api_example.Electron.html | 21 +++++++++++++++++-
3 files changed, 36 insertions(+), 1 deletion(-)
diff --git a/scripts/lib/api/__snapshots__/conversionPipeline.test.ts.snap b/scripts/lib/api/__snapshots__/conversionPipeline.test.ts.snap
index ba61e172734..1186fa329d1 100644
--- a/scripts/lib/api/__snapshots__/conversionPipeline.test.ts.snap
+++ b/scripts/lib/api/__snapshots__/conversionPipeline.test.ts.snap
@@ -70,6 +70,22 @@ from api_example import Electron
ELECTRON = Electron(size="2GB", name="QuantumComputing")
\`\`\`
+
+
+### size
+
+How big the Electron is.
+
+**Type**
+
+str
+
+
+
+### name
+
+What the Electron is called.
+
Create an electron.
**Parameters**
diff --git a/scripts/lib/api/testdata/qiskit-sphinx-theme/objects.inv b/scripts/lib/api/testdata/qiskit-sphinx-theme/objects.inv
index a683a81120ebf4530951b3139b4cbe59e651450e..a6810e492c3d7018a007c136f43512c2b926eaa8 100644
GIT binary patch
delta 2431
zcmV-_34r#)6XFw)e1A!E+_)9K>sO$vr&3APK#q0v&1%UWrKF4_b;?H;nuNMBA_)!&
z+UorJVBt=zZ1(8T!t&nty$6EW_<#x$;dhi3DF(&qQ$~}Tr~V00K@u8&Q2Fa4%hHWX
z!(RZrLcP}YeTrjN(p;#=DXJ>)5mc<+S08jz3d)3Wy?y-r@_!P2-tC?rZvVTx7nq2#
zlI&}S&%uq4s662H;AmEGh$y2O&RLzwro-$=lXFlr(Rgc_sLY9e5_XJGRAQ8-r<44r
z(uQACWt7tV5HZ4}At!hfQi#5g^z=2}JmcXm7Bws!umLN}WBWgioeJS91fBqXk`w{^v6cK;sZ
zf)T}ryUfRSY?&x&EuY9d$m~|+zVnX#B%g6L9C_Bpc8y4@^O2n45?3rL5yKZ}Q*X(~
z(F=1SlAD!CUWh0iP%V7?*-4HSZ3perx))*~+k<`3lYf;J;|R&86zy>;-Y>IFKzRY0
zG7I9y(jc*X+xi#GlYA5K0{e?D^g(51PRv+Y^J1^yiebnI)>zfCYgy3GCzo?{Hh!Ir
zux>+)hr7!)!M#R`Z`UDLdj4@@0DEKeP;WeivyV(>9u)
zsLV-zfZY`A@0v#SyDItw`m&C^*^Zl*7=zuqcov}D*#CXdVg8{36TJ^M^>C1Okr?%Y
z$YaXK)|^#NwoY){By?!)I?WB&OMYonSNtI*_C?O@^Z;>CmWu-%2+Nu_3;I1q7q1mWX*p~(qYao`H@+Ya@
z2!k=-i9<#ql8*@zhO=;+ELi5MFe}UC470fMAUz=_89F$7K_jHL7BX!_*}RfNU0NUQ
z0DrBM{-XYyVO7!-wGq~u`bS-y_>#-vaVsTV{+G&_fi`_L(czM0m2SK#1#B{)?|eoO=TFCqy<(ujUYX;q=}?)^-R0RHF7~<;}n6`^k`&9jpAi$w?j~4J|@@=1AlB!lOr4n6Jx}RWQXrIDfns
z(Om6CmdFkRWQm!Q%vYyI9wn>xMN`D?n}%zU?FHpX`%=r%$NDRDfcjvqmfp4{CQ`K_(v;GPdC{@IwMKD0QQED0d9a@L(0g7W!1
zodByDEeT42IC%hQKy0Ppn@v{oO@Bf>KT0+8Z61b7!;GCPJHggWD9nUt(8%88PgayO
znxgq=xXPd4WcZyiDxP`47knu?(VBUC`MjbrkKC9YH)cn7+?a3Nm`7#IUqNDM^BeCj
zexv&Mu6?ST8#`oZm%drnr(3qJFK%x9$#w%Jw`0+PKPFtB9HaJ3eAI502Y-0yOchEq
z&@>SiD95R5dEW?0%fHFA5vAR$$O1peu}ZVSaj=NZsV}^e-HKl`U{caTEaZJbd-=OI
zWd;vwjYinj&J68+5vAyk|IE-zbl_9o(fRmWxuyp+S@0;AOi!qMs|y?U1|=C)JB!Mj
zXQcGGPg{xhDUILYpS2j^{ePK8TDKwt{v$JPu27Z+-;Nw(`JpF)VzTll7^`iY91uA>
z9bqW&+4L&gHf5)v35KB!HdNa3v{%#dtun3on!YOz;hX7ho1(tcJJ@xn$ac=zak2$J
z!9|H<+1^l$`2IXI&AYw;hypvW&nfJbvDY!4w@z4SEEn{l{bZtdr+>0Oy+w@MB4kVK
zA;K6(dUs8hZ&GsyBhHE=65&)*7guVrEVnRfZyjKT2iAQjB6m2IT7ApSP9tKq)_p!Z
zG0A>JI{~MZU1jj(Hry^tl&!g$`=!P9MabZI?r9w%ECl|G=mF9hMDG07I=;mj20xWV8v_psH`C3
zi-5A;mn04`!2+_Ab-#j_rt(+7Yr(UsotRd!lJ9YA-jyBe@_&J#T$q2wIp%oam6p8A
zviU*Q7+K7lwFn*eS}RS+bjo*4k#VtP;;*plSis2Ms&?EjSa&|)V1|U8K`ykX{NUli
z*Mxe1j{m)OZ$eiVV8Yo}7!2{W<)Hd5?E7wj9UA4(cY#b}->if}+TGlI-<>)?mp4M{
zR7j?cD4PQj@qbRLzz=e)@>OKqEG0<-Nd_8UdD=-KKez-@3^l~3ASZ=PLb1I
z-J~a(URN@Lz7&X3hXGXxW7Rt~3;ynIPt1Fh{pJK{b1u}4t|Ev^e@R1ExX70F{?yqf
zwLq4-g$CLJsux*m3!F9yEwp`ln{0(T5&N=Y83zKMUwK1n!vuE)lG#jd(Gd5E6~24-0ZaYoeg6Q8`XPQ0+u6n1FQcxz0>&?T*=YQwu<97RWfAi<|PGBO&
zO0ugNJ_R>EpmLAT2S>AlLqr+PaL(#Xb{%F1nw)}~iOxHhiOQVlCt-&OMI}aQdOXU1
zDsA{RRYobz_Yotk87C(PH7=%vo%^MDR*%~8g&yS|Lr0kNnk=??9Bl`-?7YgUZUBSQoP9#Xdt*3{yt1##tM7EerZ3;BpO}&0i-YoVO#!)7|B|
zVa#)){&~Bgor5pe_?BU@<|P`uzIcPziyORN*x*X8O@n5iqmAWewlxDiPpk`{(0?F-+E>rGEd
z#az!^$;kFUh@=T(wX4$c~~)dNv)G)^3irufazh<{diqy8H~6Z}GQBBzUho}Fpkb_I?e#(AA#
z;e#Y0d^4@PuE4?fLU5{-{FnyvpF|Rfq!E3e(yBt`(GR(G;=!a^RX|dqFwVKG$;gvHl7jpgv153K$lx5`N3i5)}pC;9G53
zRkfV|tiM79N)@qb5e!f|N-cwbgU&;DfnLce!#he}uSs#tca{cqg7W!19s#QvEeT42
zIC%hQKy0Pp&L%6llMv63Qq6p;`+uR*Fk|P+j<7Wo3Ns-Zbh0=3qZQ?Zu4q2Zo#jt(
zGW^CE70OjbR%sj@2a9k{ec_etM*Nxqladxln{lCoD9U8~V_3GSRzLS)b7&=4}yWC4YQ~FvgMIZIk6r
zYVKgfS#jVi-2bHuo#RSvmZb}$eCq%!Jh1LM5$WMnYWFRjokqlJt^0g-Vv_xcb^=Z*
z%flw>UgcApvQjt?f+zU4vtS)E4DO(bo?-(3^6IeW6J#dW+W^XuTJz!3W6_pcq3_~Q
z=|K>AyoD*@3l-mXhktX8^d3~!hcQDeU|o>XkNn4ui5UvO6w;6U$BNnI)ag|4qc`X;
z*ujNSEIAp93be_7Tm4%5gWCj<^3^UEGEbyEs7%fO#!HU=HP+395Hvwh6D@hz;
zf(2wN>wW{zP33QZ*McWiJ29)?mp4M{R7j?cD62gY
z@lLA14|1&XS$|~QEG0<-Nd_99dD=-KKez-@3^l~3ASZ=PLg8K^BBPsxH|a^H*OiQ*
zF9o91VL%naSoMvX1%G$9C+4Hcescn}ITz|mR}n;|zoelnTx3goOX*~jS|Cf^LIZ69
z)r%~(1x}lU7TP|&vvr1Uo`IbGL
z={>vCdvuEEBecx+)2{QK-qO?f&kyPB#bv8nr)68chL^KEmgwnSE?}tipc=(LXGhrG
zAqzCYh;y20+N*90Ow;0+Ol$Y%sAFTe%xn=lqF&zJRu>7l3mdP3jhl|ABn*uG`)`
-
+
@@ -291,6 +291,23 @@ Electron