From 018162f1ef6f1813454e113ab5679ca5086460d3 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Fri, 26 Oct 2018 10:57:55 -0400 Subject: [PATCH] rtd: Fix warnings in RTD causing autodoc to fail This patch set fixes warnings [0] in RTD which are causing autodoc to fail to build, resulting in missing documentation as in here: https://airship-deckhand.readthedocs.io/en/latest/operators/exceptions.html Example warnings: WARNING: autodoc: failed to import module 'deckhand.policy'; the following exception was raised: No module named 'falcon' [0] https://readthedocs.org/api/v2/build/8001684.txt Change-Id: I872b90e03a8f9e3de3fd717ed340b53f095f01a5 --- doc/requirements.txt | 6 +----- doc/source/conf.py | 7 ++++++- doc/source/images/architecture-pegleg.png | Bin 37600 -> 37602 bytes doc/source/images/architecture.png | Bin 23230 -> 23232 bytes 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 280af85b..f9e6b367 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,11 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. sphinx>=1.6.2 # BSD -sphinx_rtd_theme==0.2.4 +sphinx_rtd_theme reno>=2.5.0 # Apache-2.0 plantuml -# NOTE(fmontei): The requirement below is only included because readthedocs -# depends on it to work, since it only takes in one requirements file. -oslo.config!=4.3.0,!=4.4.0,>=5.2.0 # Apache-2.0 -oslo.policy>=1.33.1 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 372a92ff..399dc0a6 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -18,8 +18,13 @@ # import os import sys -sys.path.insert(0, os.path.abspath('.')) + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../../')) sys.path.insert(0, os.path.abspath('../')) +sys.path.insert(0, os.path.abspath('./')) # -- General configuration ------------------------------------------------ diff --git a/doc/source/images/architecture-pegleg.png b/doc/source/images/architecture-pegleg.png index ed0a368d7dc2d6c20368e0d49c1c24f9d6e05e70..85428fbecddc16ad1cba24731fff24c8b9862b94 100644 GIT binary patch delta 533 zcmV+w0_y$Xr2^um0+3mM`e{^HbZ~58Zgh2RYybfO004NLZBkutn=ll8x5R(A;wgCm zg=pC-9-=A<>&HONMw&fDQRTobwF-7*OuA^=f8RBbG?gll<@<4t&pq~aZMZf~RXWUm zJTppzyNFzep)|rA!M$CrmKS0AGrov^r#E-5MLug@At5n)ec>{Hcj2$Y05)?ajaKCr ze18g?NESlk)?xoHAWJMtEKYzff_Z$`WBSCW(1$(B)bQ*T=BnB&Nvi4-(TwYz$hhoj zQp_|ONNGNV89_Xh`L^x+fydgYck-MYzT>r(rfO4Yv?F({v;z+|c|YY-zB_@eOSaTl zM=05E!1Jc>CqN>9^1Q@1uI*u;rdxo8I?S$?^5h{QdKWrY5@T~`i`(RRY^r>;uB)GY zTtwhaKlp9Opgs8lS`;tF4!np$Sm3@?$BNADsZiSokaxWfyQZ~$L2OxaX&#dp4ybFP zBn19=6kPeic#t*{9x?;t0D@5%Oz4Nl)f{Yn$Obpd7;4pj=nNqjwb5eN7$O+5dw$^X ztD)ysVF)%Ftdb$5(J4uq4niww^|AYP(lx=YGU;BKw)yK9ZzkyOQIjrMCmrd!(-@M- zZ~o|MJn?qHgwd1I+z44fN|%FG2(ggOAGW|}-jvpXOyyJ#N&R>4ip5+O4KGL=N;X%d XNgt_}vi|`GjRfO_Qe1emS^|cUcPIj< delta 531 zcmV+u0_^?br2^ok0+3mM_py0%5 z#KDS;-Fy_QZgJd$Wkm~2$SSaFEsI;L>VNO70mqRdq}9&Hd;8`wx3%HgG*#&^`|->u z4eo62It--|<^b;fYPCEIlOOR}^eef0a4qsh^9l)x+1o3ZxeI@P9R{$8lr&nETk!n} zZ052M61NWfcLrHvQDV^p+6bcfp~G~EPodv;C=jBdG}@6{R=R-)o4lLyIZu0#b;*_*>j)*g z3wYk-{RLQvJTLKoH`n&DPt!+$g*wchma_Md5S6)|w63k6e4Nd} zn|$!wjzM?w1+*w$jU9M44`GJ8QXMKXx1&OB7a(tY9d=9Saf8^h^VqTBMC3f+2h4dk#Mv zTDJ;Au+d<(7(z1dlcZ@cw31dIdt5KtCb(B7*(q~uzP|FN!alD_7pxa8>AKYzlE^Rq z#q((FrNNldN@;F{EFhtugH;Hzkj)=9!x!F^)`3jrR1Qh~SMP?!Tow&4NE=EPDbl15 VR7==@{xSpw;4-KbWwTrYhL9a>1MvU= diff --git a/doc/source/images/architecture.png b/doc/source/images/architecture.png index 1ba9361d58b5bea75dc48e701c0ed3ec3751ba53..225a7948a1df51544fda4413baad11ccd1e9bb54 100644 GIT binary patch delta 468 zcmV;_0W1E#wE@7j0gzdLx@lBcbZ~58Zgh2RYybfO004NLZBb2c+b|5h3-Es+d`b>B z;$YbdABrMr)~>VBY)Z335EQb_dO~d}kfm(Fu>U^FPMRJD34-|X9v{h@&I)5)+XT!X zR94y}g!k+9D!iEdTlUWS!SB9=KKsRp79qUF^7W@sRS16q2C!X!Xl0FVb`ZzcuwANJ zD%=I^?>orj9u>Eue1(N>_gWEkcZSb}DP$?s3D2=KXn|X85atAlP*uA=^D7=Zt1sl0 zu%Zwh@vn4eYlB|*z)C-eU|XG}K3ByVt)8eW?Jstf~fo3FC|X*WCj= zG+_Sql;=SZ;xvVSftAE~-`kve=UdwWyP*#Im9SMKlzqxGIH2jIR*=NgNpck@(-C(H z9!m?;1d>Ub%;>_?dI3H@W}~}R2Ay`MM5ttEjVzocf-!p#2Laz5?Xtxbyfs?qW8llP z6PD^AjaDr!g*|NYAqnoa<$G=WyQqDJtqF@OClRN=!vj{&TvT3Mrit2Kn-C9GzulnU1# z`}jtA+@RuCT{7DNN!Y@YTZ}_?jH~Ym&Xo}%A%<7O&Hhgzi>xzRFAp8 zlRPYf82c^ss$|B0VPAXdz^}1Ac106*Ct>qSDEpKqutn2Itsn|VC(%V1MFTEqDY${r z2%_`&>@*&q!qZ|3E|SgI{BG%%HOAng!6F?3pB+G$ zsjW0x)pQhgzfAigxYd?#wC#$|&w`0`?G5>YW!j4_dyg?hnfwu+Jdegf7L6I5+6XIE z37nRObqtAA?K`{17tvOhy5+i{bWHAl1{W+5s%%9`-cYfrCQoKZInF)-9z@X35lY_` Ivm64XSQ}B`zyJUM