From 14491426b40ed547ad2276d86f1bffaf669f2b10 Mon Sep 17 00:00:00 2001 From: Paul Nation Date: Mon, 14 Oct 2019 09:45:19 -0400 Subject: [PATCH] Module level documentation for qiskit.visualization (#3187) * update visualization docs * style * add width change * quanum -> quantum * add coloring to function links * add otehr visuals * simplify even more * more styling * styling * a bit softer link color * add example * add inline * Add qiskit-aer and qiskit-ibmq-provider to docs job Using jupyter-sphinx to build examples in the docs enables us to actually run examples in the docs and get jupyter output. However, the module fails by default if there is anything printed to stderr when executing code. The base qiskit namespace will print a warning if ibmq and aer are not found on a system (which is to provide cover for python packaging issues). To avoid these warnings the simplest step is to install both packages into the venv to avoid a warning. This commit does just that. --- .gitignore | 3 + docs/_static/style.css | 12 +++ docs/apidocs/qiskit.rst | 3 +- docs/apidocs/visualization.rst | 6 ++ .../visualization/interactive/interactive.rst | 13 --- docs/apidocs/visualization/visualization.rst | 22 ----- docs/conf.py | 45 ++++++++-- docs/images/logo.png | Bin 0 -> 9489 bytes qiskit/visualization/__init__.py | 82 +++++++++++++++++- qiskit/visualization/counts_visualization.py | 16 ++++ requirements-dev.txt | 3 +- tox.ini | 2 + 12 files changed, 162 insertions(+), 45 deletions(-) create mode 100644 docs/_static/style.css create mode 100644 docs/apidocs/visualization.rst delete mode 100644 docs/apidocs/visualization/interactive/interactive.rst delete mode 100644 docs/apidocs/visualization/visualization.rst create mode 100644 docs/images/logo.png diff --git a/.gitignore b/.gitignore index 1a645c41440f..f97eea26d89e 100644 --- a/.gitignore +++ b/.gitignore @@ -140,3 +140,6 @@ src/qasm-simulator-cpp/test/qubit_vector_tests # Cython pass qiskit/transpiler/passes/**/cython/**/*.cpp + +docs/api/* +docs/stubs/* diff --git a/docs/_static/style.css b/docs/_static/style.css new file mode 100644 index 000000000000..84980a3a4a60 --- /dev/null +++ b/docs/_static/style.css @@ -0,0 +1,12 @@ +.wy-nav-content { + max-width: 90% !important; +} + +.wy-side-scroll { + background:#8c8c8c; +} + +.pre +{ +color:#BE8184; +} diff --git a/docs/apidocs/qiskit.rst b/docs/apidocs/qiskit.rst index 7ec6e33787f0..62447593c352 100644 --- a/docs/apidocs/qiskit.rst +++ b/docs/apidocs/qiskit.rst @@ -1,3 +1,4 @@ +.. module:: qiskit ============= API Reference @@ -22,4 +23,4 @@ API Reference tools/tools transpiler/transpiler validation - visualization/visualization + visualization diff --git a/docs/apidocs/visualization.rst b/docs/apidocs/visualization.rst new file mode 100644 index 000000000000..4dcc8b7c076e --- /dev/null +++ b/docs/apidocs/visualization.rst @@ -0,0 +1,6 @@ +.. _qiskit-visualization: + +.. automodule:: qiskit.visualization + :no-members: + :no-inherited-members: + :no-special-members: diff --git a/docs/apidocs/visualization/interactive/interactive.rst b/docs/apidocs/visualization/interactive/interactive.rst deleted file mode 100644 index 860762832720..000000000000 --- a/docs/apidocs/visualization/interactive/interactive.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _qiskit-visualization-interactive: - -******************************** -qiskit.visualization.interactive -******************************** - -.. currentmodule:: qiskit.visualization.interactive - - -.. automodapi:: qiskit.visualization.interactive - :no-heading: - :no-inheritance-diagram: - :inherited-members: diff --git a/docs/apidocs/visualization/visualization.rst b/docs/apidocs/visualization/visualization.rst deleted file mode 100644 index 55017a5423ee..000000000000 --- a/docs/apidocs/visualization/visualization.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _qiskit-visualization: - -******************** -qiskit.visualization -******************** - -.. currentmodule:: qiskit.visualization - - -.. automodapi:: qiskit.visualization - :no-heading: - :no-inheritance-diagram: - :inherited-members: - - -Submodules -========== - -.. toctree:: - :maxdepth: 1 - - interactive/interactive diff --git a/docs/conf.py b/docs/conf.py index 509870b102b4..a196960fbf5c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,6 +33,11 @@ Sphinx documentation builder """ +import os +# Set env flag so that we can doc functions that may otherwise not be loaded +# see for example interactive visualizations in qiskit.visualization. +os.environ['QISKIT_DOCS'] = 'TRUE' + # -- Project information ----------------------------------------------------- project = 'Qiskit' copyright = '2019, Qiskit Development Team' # pylint: disable=redefined-builtin @@ -53,17 +58,35 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx.ext.napoleon', 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx_automodapi.automodapi', 'sphinx.ext.mathjax', - 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'sphinx.ext.extlinks', 'sphinx_tabs.tabs', - 'sphinx_automodapi.automodapi', - 'IPython.sphinxext.ipython_console_highlighting', - 'IPython.sphinxext.ipython_directive', + 'jupyter_sphinx.execute', 'reno.sphinxext', ] +html_static_path = ['_static'] +html_css_files = [ + 'style.css', +] + +# ----------------------------------------------------------------------------- +# Autosummary +# ----------------------------------------------------------------------------- + +autosummary_generate = True + +# ----------------------------------------------------------------------------- +# Autodoc +# ----------------------------------------------------------------------------- + +autodoc_default_options = { + 'inherited-members': None, +} # If true, figures, tables and code-blocks are automatically numbered if they @@ -89,7 +112,7 @@ exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = None +pygments_style = 'colorful' # A boolean that decides whether module names are prepended to all object names # (for object types where a “module” of some kind is defined), e.g. for @@ -113,5 +136,15 @@ # html_theme = 'sphinx_rtd_theme' # use the theme in subdir 'theme' -html_sidebars = {'**': ['globaltoc.html']} +html_logo = 'images/logo.png' +#html_sidebars = {'**': ['globaltoc.html']} html_last_updated_fmt = '%Y/%m/%d' + +html_theme_options = { + 'logo_only': True, + 'display_version': True, + 'prev_next_buttons_location': 'bottom', + 'style_external_links': True, + 'style_nav_header_background': '#212121', +} + diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..c4f83672e4046aad1e65cfda275129e5c64dfa1c GIT binary patch literal 9489 zcma)C1yEeUmK_FnPjDt^a1AoJySsGyGO*>08UO&ml#`WIf5~J2J}5{p?*r-Wrk4!CQcOt< z0QeSz{>K#Yr4BNaRaXK4yyyUcfDi!S;ROmf1OQyw0f6K8001}@0C???*`g*0007ag zG<98cl@!5d_O`61=Jp>TtRA)wFA@NNpa=M+XbW*M1$o%o*g1negsA?(0Kb&~!faHa ze^6XL2~p`Pse&ZzogkohtlX^ZRKjQ=5J=F;+ybmFDg7_;mzogOM;8|dFdLh@yF05p z7puLKB^w7nKR+8gCmSax%L{|W+0)L&)Pu#&nfjkf{#%bE#M#Wr%E86T-VXFvujvPS zR~I2Fs=tQ*o&MQQ7b}bZv1I4`uWr3`knQgmHV#&Hwtwq>5f%K4g4H3;_BO76)oa;V zxd?L#{)7C#;s3GrPbmp|TL&kIv-69XFvq_{{uBG(d=)1v$V>nJn)x^XKe7MKSN&-3 zV*lc6Co3~KI~R!4i?M%6|91obZ^plL39|il*MGS0pJVe6^kr~_(FEE4J3?!BrxRK?6iRS>n&k?u@z?fw4BV z7zp8G%|SNFh3cfA(cqHJgKbb$6;R-rx0dzIqXBwYrYQT;X3k4Q%qDl~X8!)a)@@WK z60Th$rAa!gk25+R1sI;8nx3mNRu@NXx1aUk-7owYiUGRa({~sVy8GANHx$e?n zZexQoUz^m2$OlB`=0Ro3vn(!#_Jrbx?*~v`SXiJ(ZB$rh1t945L{@d-If@5bkQpj_ zg^p)K5sQD^0?X9UL83F`qSEg}XSU>L^bzPbSvdma@uR^cS^y_e>aH;7_HgMBpmV9i zQh1Fq_(4x0DPl6mZ(L*Y%hpB-K{>&^UB)g1X{H{$O}cvAl?Dg{X-RnU2;4vl0H3V` z8EY~gcVtiAhq)44gk-Ff%@1#-3O;_j40e<906;%Y;t5MLDP^%j$Bu_%2;P7{;Xj~z z4(dr6(=*5J764@R+6{_<(jW|UoO@ZqrVQ z+?f$TP?D`=X7q&{O7fL+92sSBZ-dX}avk?*{LdRwoB@Y|1-E5NfA~qh@@aFX>%(FKHbMJGbU5+UXu0QM+g`; zy-A1wGhn2(AUIM|#LjG1k!8vWhxYJa6ZJ@SuIA;l$RM>Y5kJQ-$~?C7M|;! zTHBRcV_Pd-k$b?4@v=+y6A!zCv4lTS&Dsa|D$A;th^1GCNgQ(>{m=;6M#vcq4;NLi{G2cByPEQ6pE|I-^Ks6mpf47mr@4S!sl3?XJ z)jtcennV<2-PC9<2BCJP%Bvo|i3}Pf4-XH=-dTo$7|TFYo>Ehkk% z6C%$(bd`c^`AVsOSQj&K*UHdsDVq_K&}1+~`MYMKex334`$Eipwr2gOs?8c~S8fU5 zuao-w`-LBlpYL{J>H=l&`(k}8g9Z?l=~On4&d#)qvjE&~r;EkO$;otpInl+%+1U_l zv~-dwd-Od6xP^WCY>#a-17e#6n`KnCnh{yHeBW8>PAa{0YbIs>t}DFZkFa>*>q&`> z--~83Sstnq7eBmzHXoGEC<}}=R*j8~4S-6Fxd8A*X#=!eKZCkPolovD*Ba2~OxDH) z&JD3WIJu&y(|v2i>eS#tUy->LBQeEe0Q0lU%izzd)vd|R&Idnb{K&!836yk7>DS-H zhp)ji60R&Z)4L$0n}AOV#O2KbnZAE=8OC<9X0FXR)oCrJHaj;aYv#c2?L z%<$T;uR6@@S>6Ckv0ps@r`7*=>jtV~BZkY9r#akhG)fpF8YuD_VWP$L1*aKaptKDG^|hcK-{jtK(lUAc z8@Q6VdR^+4?}u8Sqs+cpVcZ@i&0}b%!)bHf-vIGffp-r>?k3J?18V-YqPJ)E{;ga2 z5v&i5!C2r!-~$h358`#6N@!M2MAhiVXo4E58qsTUWi+0sDuWK6d-Mepe;BzzgUu3> zYD2Bt(&vIkV8GJ^s1~7=B6HdKAj|#9XZy#OI^W|~9Ls*+dGa{x0W#;&=tbUWokau> zDiA7MyhV>!PqE`pe-v&_e+*@3Fad&LWk6ME%UGS|#QMo;-9$$~iy6xvleN1PU^jq1 zFfSO%zb~AS?fJH`vz;{HIxs2fy(Lrd`XSKjMac==47jU4-eJzRagFCwNtT<}pi`=j z6ETczQ%m*Cv*L=*>|{Iu^16nTkfN>^OW^aR;H+&b2+%at;RK2^1 zXloV#jGRYUWFA#%Y7xJ<#`y{$Jt3$Xa5L*|`?qHMOSr4t@P!ruiEvspc>H%^)X{uX zwJIjTA-}|yhuOTH7U6ybxaZ!~7w!x9;}cWZ!Qfyr=e>H2laOGq9+ja%K$yxu_5_8Ek&Xmln0-_JAAL}%jMXw;w<)AF&4 zua_2>JYA-kr6o~~$`1tQtifrZb4|r*lqhGJl8mT>l<&p4s#kxR!p9;JzHf_)6G)R6 zfnCqU_+NA*m+M^#ez%$__U`xyguG0pQG?t#`db1*ne{p)N7w(#91+t1eX4lxz^W(;v%>sZkS znZ)vQ>z@Z(P)ds5gVZrTF#k6e*S5vjsi8dnmqYa4+I3G7E)rYk>C$h)arq3v(u&(7)i_Gf^t2!;do`w8k3U^x^zOpJWXU=*&L|DQ#5I#zcDK01;mZ9`@ zDeNHOfQer2mGR<)N?hbhxTX6F!>%>1W~ORZ0n2f|!$3aZDUr_YaQ0w2SYhf`5b1tTgZ2%|4l40`NP;Ax0 zHHqdLA926c0!2M5T_ha@*+IE(x~Rb(V_^nfQ%!<~GiO^u4^Ck^#ilgnMJ+p{@MCO9 z3v=JLg-oKW{+>lGm8kgp9|Xrg3W~Gq31pseGST@sIlg*T8U0vEvYHZYHmJ^jGdzfs zv206Q3fh}-lVT#*5o)z&%_I+)_btae)maRfsc%$?jYOSI`}?y&3(ftW0KHaZ$-r5 z-p%bBEw@q&8E7t!I_qSbwfogj5UqiiY(u$Bd4YknR{r}@*l>|>h_1_Pt`1~ciRyu zwS)~RMxO1vziYSJVtjjlTFv@_@lHOfh!~I;!`1Ruj#rz_q+P#F-j#rp%^QKY!XoB* zUyem`Txd;A&rAYvq830TJ#X5HZf-rT9WkC=iix_aTRgF`R~RcwxD^`MQodHfeV}rY zQ+I4oyH{U!CpikrF9MX3%l#&rZc(GLDfE@$koRpiyuhvwIIhMRM|0z2rOl=~^}C*u zNip`=3I#TyQ)OMBl>CtiIFm_s;+hnK?A0xP_J$43{~rzD*-eW@1s>hVSG-uNN@JR)BmKp?XXlsKj$_(Ec3GIf7-aNbqH zk)~&kXMiQ1V&dl+g1J3VgXzqpa#Ym;9#TVvvXpGtnIC>X#4C%26MdE~U5He`#=j@7 z2==t%oxwUPk7|p}m{1hI@yhZ;p_Y(Iqkm)BFiaRP(p_m_Bil*J*L_LT%Aev?afI4~ zee?;FYo0z+cZyjPho7hIBTqc8MN6#56s8)@m)yuYvcQr&nG};P^w+F{@o;NtzB2-c zWJJMYwJEtJDSq6GLS&BFj(1zoiEJKQeNtpJY*W?#$FolD6I6CGK948Z?+q2<$J06m z&$0Fqre@Tf!@D}=Y99P!Sr_~Yvq{Q$L*kf$GaYB`*X(XqX!In6`&0fsvX9ZP5J3c! z8cqH2oT#*gy4o$*(+bbYI)lbuPDcfltB2gjuQKN+K3OJ+QZs*r@B2Ef05hgPy+79J z1UI+0!vfaaR%}gpP9}Ohk*Vr-O9ab%dQECx37A;4p3jUj+lxHi?VPXsJ)V8~rX$+j zHX#QH;skuinl0lzooAs0_sQ4leJazwTt`$qH}*cO_a7?)!%oCR=1MiL!KJzYDV(R& zJW<|ZXwKN1HarRzGEv%2GceMESbPj@kQUhR!KK|hGVL?tjLY{x2NqWs&Udg- zHXl=XjfQ!SU=&M~QCln~ia^5jI_e?ZBHHL{1XB{_@Ly@$5@8u~bWQ~Wx?LP_*+9{2 z>rq2&>WjC^9d-{y5^cDk`nNex+|;((3r`gO$zmweT_+m_;46E93#*_q^nQl@_TRtN zkq@h*QhsF5TP#A!S$2V!rRK`D8~unDD*n)E+FY8^lc?2=7?P3YKxJivt2!)RL0A%y zVg%^7V;;0D)tIhKPeUMa=jququI-=w~7m5 zguPOR66hyPMfLT}ly-gQ5U#z#6TVGgG@hzI9wbMv{aO(|e3D|X!w(qBOnDvPk?~Gr zeiNtw0UVK=ua7KWy#o+X34cTthvnC(YEl!(=63z6QMhUXSPO3Qk*^-2w^sgeZI#}4 z`P@Z=!@&oRdf)_j-=u%4^6a%0jNf7?$#m*@nJl~pb%ocU4mQeq|F-wtK`PSf)#B#< z&yO1$gaKq24i;QYN=3Gv^O8XP`-cy8*&ukv;e-lW|8b(?!5pksZfp$N)sT%EUBFES zkk8f&-{e%u*@BcMgo_J1IREgK=#0|c#&^&A+7Z?j^9J&xJNJ&Otag4pAGm5ZU)}_M zd#tc^p`T4VPp*ZoOwz(5(6omtRE_I^g<$H+nD2`epiADDrN@`YSl^mA1-U9ycCA5h zyYFDMpswD+nH6MJ?k)3d3&1t7y8LF038v-?Yg zc3x{eyAY%7lb+ENnSXUvVmgAb?NxL{O)92=k3FO~y4rhq!g%~6@_Y5iglhd@rusBF zKyBRb3oI`wI96EXB%o8_Ny#waI$W<&e}~zhV$u7&ePU~*`I}P};73U==@hSeCHP?G zWYu|ME(_j&bMY!Ta-=VEiot7;0~-Tku^dE?&6bAf9>j?Y_8L7?1Z>Y988FB5S{CPa zbSPJmHjl7WCtXxFuD8T(6m=jujEK5}v`d06IQ(-qXG-*He@vlv z{PEQWY5Ndg6g{)Y<;A502Y}=n%}jcF?vp|46Wi{3$3lC^tT+WgKRSCsuVuWyqclmU zPA=Kwgt!FVBe=aU)hc5M@XKoj0^-QTHP-0t`U?Le#gUXR!gt2@B)Oem(fYsWm@arGcq$`t?H! z_8o#o11DaSNoW;d;`FG`0tNTGp)mW78g!>4S_+CU~=M`h!}W`ogGl zQ}{efb+M-yI#9PFt3dK}2=5>$c%89$;e!RJ65j@|l*-K_s-%G8VLrdnYbXO5{(ID(RVp5pB(1uQ~bq9-(UwyCpB z-i^_=x4DIhCT^yPZf`|;E=#V5WQ;UX6hdVBhNF;sc9MY{47Bk<6nok?frUs?zEWEb z#leiQU_XwmgbxAc8BH4mns(Bw^ZSak_f3SdiR=WFY%H zM%}qZ8)*)|bMZ0e152EXvbZiOv;PlM17STq1|>OqvIfN11-p9rMb|&Y5zF{N7brj^ zo+RA!efj|QJbF1(v>)h#Oy(1_Q)@Jt0U956Y3}^MJ{jopV>Nc+aXl}Kc&s5^Ls(!u~bBcZ#2)d2uaXdYG`|vUMiR>EPG5(|f@NIxQ*CR7~HXNocLZ(Yc!=Q@lfk(l* z_;O#=_w$bofLe0B8ayH@b}2Fn?zbH*7o{kr**$My7=`0m5LRtaHkC*p^W*@=q>5iS zOZK@J_e5IgI4+~0g*Nc5|2{CJJZa$Rc;{=vz5mT1_?1v1IZzP!tva387eBlY59f@9 zDlX`1{!w!lNU*{RL6aeM!0eY01q=o$$`~!mmnHdH9+cc|Q7+Rvhs$cZklj!jN@_iC zoH%AOa!2oLeipAg4R7v6Ht?)WZ z+mNW7KM~dQRu}nYQR654-02CN;2Up!jlOe~xspDVJVR`=x0YeG@q|0s*k)ZFc2@2I zt1^ckFs-evjp$V9#_jv%VW)B!Y>vulSk#VkSlH-|Vf^k<@w>zylkPy>=>OW*^|2<* zG2(AvEd?*Du1crGJ{5a-;;^jZ|1cxrkwu1ZjvC;?D(s9!fgGR2-&gj$S)oA0X$8w$ zF9|rse`0YHDv|DOV|2*}VKjCFtHd>4$7{*0eN5uy8+x#X9hKxf0pa;WL+i&oRV>Wl@MYFO&Wm5!sISN6W{h{EjU@xuLKq7z;Z=m8!;&Mf5$9&t z{mF&p;M@ZI4d4;6ClNuE0eVtHEw;+*7=;OaD{g9$mUclAK+lsp!?k;KM?t`p~OQm*M#7emH`$ZJi$`JReKCVXBoE+^EI!4O}uyIKE(S>odQx?OIM_ zSybnr@-wk4*ur-P^Y_m*h;TJH}T( zAWc5GOv};3TAASep0oy3tYA`&W?{cV52^U`wQcmha;2sW{|6GIX zlt@&CfPPPwO_?m@pEFX)vHI6{_~u&BtE*8*5zN?co+4OV4m-Az+dY15H^1M<=*oX4 z$4(ZVIcRh^%x5tAeaW37>0{!RtC6_*s*hYhVjZX@r-=nXWoFaYAAKA#dE%rf@*f<% zOpC-1L!cM~PYMZ&xnD9c)p;~5&l_I$liL4zjdh^hTUGhTkOLo{=W^)R%N{~`2*>K` zD^s2aI`HW!K&CMjf^r{2>G%UTh3gf=_6(-)E4bX!I9A4GO--f(TzMKbWlCDh)}_ME zz65qc^#0?QNhS|@FWU%##j22zW8oO})67N->!U-AEhD>!d{}Zr8&D~}63*nPf88aPMFXV14dfS^XEEt8bO#>w zV;OPZ5UU(8wbgbE_0&8*NSl{_kk!2N5?WXp`@?P!FNJtJi>HsiFFeP_M1~miL$)hQx0)0+5BBf7omt!|R7RFO z5(&`Q8?a?%qcuXA%ReSqY&fL*sAl z{8GrvaZ!JoR9RUpT% zV?@mjd|Dsio%W~ZJleX6%FPSY+@?uUJX@3$+I}eVS>b2RO$4FwOljmyLMcOsTXq;# zdq@<+BFz#7Yi(=A*rCSzdPuX=#>jHbGJ4G>#{yc6Dw0h3+Gq9a-VQhH)}5kjtA?cK zO`EQ`k7r&e8MfAp(USE!ZhT0hq)xh)D1syC=|T{!xsPm;C7m7*o`6!<7%3;)$2)7(bS1iN%P(v# zhV*Pv9Sqq!Kj;tzJvS>}n(MqKg9>aS)+j9-XME>^av7-shHwUkQ1f|Y5%NpPM6=j` zx$$jZNcK1->=soj@A(K!R7^`#nOops_xAoW$gxNW=>=b9Q?Wkxp|*9^#ex}0VKg}1 zz;Gom|4*?gHSbSI` z->jPE8TQ`Y63rpe3q>Z3of+FQCh7drNwp&CKXIKzq_p1`_$3uWt~g>9Q(K{TO`N9+ zYv4~xd=1AeLlhQ-*R?IuAl5>KA}retrj1Qx$JPsZfq z(8-pjTs2c{FI?0qhV3RLy8rd;Q!;C&siR@A4n_3GK z*Ey{c$5Rh1ox%!f?dMv^$T~G~Ni;4X59t$eYkvisbzDMwYj9CcUp4_wcrp<#f$;c)#S^Lg^M{AH z850}SFswfeTwh>0VV}eJ{~o}-dpvDE$kwnNP31@_7;A<9!2ytUr#=q)ii$9j_QmgZ zkImn+U@6edM8MNl*)Lu-rv^`6gM#ibq}_tN_C($s#t5;^;FB)`7rdW*~|?jd4Nug7>e4IdpahOBr6H|1ebsvSKT zv*5{>zUtM3O3yq#?V{RX=8T;7p&BZ4LO!O7+EbQa1|NGup2=w0|DFw6woJvBj4c~r zL2;7OXDHSvFH=s)d9vEm+1Fu^l^9Inu^GsARyQHs=zyf~eA|W#INBbaTW#VIF?n7j zE>fn?98(rzPxqV&fg{|8%Ow5Wx@kyIQo~}02#VTWP?qlCn4)<2X#fvQZh16!w^!CLsyYXlfFgc5$>4#vsz zBbfihv{FJG?xWVI!33FIk7|0_=vQ|5+8B9gu&b=Q@mz@dDP0;dU=O(a1u+0YN&Om0H+g%JtG6x{3i4WrvsK<@! zLhE(l7oAfQVc^^PTtLje$QRZ?3c##gmL=*^|GClS-K~HAacxIEJxrHi;twsRYP_-_ n%Kzuq#{YTIqwCpw^BK@RVaVRmos#|cHj=2.11.0 Sphinx>=1.8.3 sphinx-rtd-theme>=0.4.0 sphinx-tabs>=1.1.11 -sphinx-automodapi \ No newline at end of file +sphinx-automodapi +jupyter-sphinx \ No newline at end of file diff --git a/tox.ini b/tox.ini index 0b1a1007c945..687190d0bbaf 100644 --- a/tox.ini +++ b/tox.ini @@ -35,5 +35,7 @@ commands = [testenv:docs] deps = -r{toxinidir}/requirements-dev.txt + qiskit-aer + qiskit-ibmq-provider commands = sphinx-build -b html docs/ docs/_build/html {posargs}