From 51fd9d63f8f6195da8ea6651e76785c0d5bf2f26 Mon Sep 17 00:00:00 2001 From: Syrus Dark Date: Sun, 27 Sep 2020 17:18:21 +0530 Subject: [PATCH] More On Docs --- .gitignore | 2 + .readthedocs.yml | 10 +++ docs/source/_templates/autosummary/class.rst | 29 ++++++++ docs/source/_templates/autosummary/module.rst | 64 ++++++++++++++++++ docs/source/conf.py | 59 +++++++++------- docs/source/examples.rst | 44 ++++++++++++ docs/source/index.rst | 14 +++- docs/source/logo.png | Bin 7983 -> 6250 bytes docs/source/reference.rst | 16 +++++ docs/source/reference/sxcu.SXCU.rst | 21 ++++++ docs/source/reference/sxcu.og_properties.rst | 15 ++++ sxcu/sxcu.py | 7 ++ 12 files changed, 257 insertions(+), 24 deletions(-) create mode 100644 .readthedocs.yml create mode 100644 docs/source/_templates/autosummary/class.rst create mode 100644 docs/source/_templates/autosummary/module.rst create mode 100644 docs/source/examples.rst create mode 100644 docs/source/reference.rst create mode 100644 docs/source/reference/sxcu.SXCU.rst create mode 100644 docs/source/reference/sxcu.og_properties.rst diff --git a/.gitignore b/.gitignore index e784765..28e8c2a 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,8 @@ auto-save-list tramp .\#* +docs/build/** +*.pickle # Org-mode .org-id-locations *_archive diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..c5a96ab --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,10 @@ +version: 2 +sphinx: + configuration: docs/source/conf.py +formats: all + +python: + version: 3.8 + install: + - method: pip + path: . diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst new file mode 100644 index 0000000..96ea78b --- /dev/null +++ b/docs/source/_templates/autosummary/class.rst @@ -0,0 +1,29 @@ +{{ fullname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :members: + + {% block methods %} + {%- if methods %} + .. rubric:: {{ _('Methods') }} + + .. autosummary:: + :nosignatures: + {% for item in methods if item != '__init__' and item not in inherited_members %} + ~{{ name }}.{{ item }} + {%- endfor %} + {%- endif %} + {%- endblock %} + + {% block attributes %} + {%- if attributes %} + .. rubric:: {{ _('Attributes') }} + + .. autosummary:: + {% for item in attributes %} + ~{{ name }}.{{ item }} + {%- endfor %} + {%- endif %} + {% endblock %} diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst new file mode 100644 index 0000000..ba44c47 --- /dev/null +++ b/docs/source/_templates/autosummary/module.rst @@ -0,0 +1,64 @@ +{{ fullname | escape | underline }} + +.. currentmodule:: {{ fullname }} + +.. automodule:: {{ fullname }} + + {% block attributes %} + {% if attributes %} + .. rubric:: Module Attributes + + .. autosummary:: + {% for item in attributes %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block functions %} + {% if functions %} + .. rubric:: {{ _('Functions') }} + + .. autosummary:: + {% for item in functions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block classes %} + {% if classes %} + .. rubric:: Classes + + .. autosummary:: + :toctree: . + :nosignatures: + {% for class in classes %} + {{ class }} + {% endfor %} + {% endif %} + {% endblock %} + + {% block exceptions %} + {% if exceptions %} + .. rubric:: {{ _('Exceptions') }} + + .. autosummary:: + {% for item in exceptions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + +{% block modules %} +{% if modules %} +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: +{% for item in modules %} + {{ item }} +{%- endfor %} +{% endif %} +{% endblock %} diff --git a/docs/source/conf.py b/docs/source/conf.py index 6f2ff1f..4859a5e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,20 +10,21 @@ # 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. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys + +sys.path.insert(0, os.path.abspath("../..")) # -- Project information ----------------------------------------------------- -import sphinx_rtd_theme +import sphinx_rtd_theme # noqa:E402,F401 -project = 'SXCU' -copyright = '2020, Naveen M K' -author = 'Naveen M K' +project = "SXCU" +copyright = "2020, Naveen M K" +author = "Naveen M K" # The full version, including alpha/beta/rc tags -release = 'v0.1.0a0' +release = "v0.1.0a0" # -- General configuration --------------------------------------------------- @@ -32,11 +33,21 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - "sphinx_rtd_theme" + "sphinx.ext.autosectionlabel", + "sphinx.ext.intersphinx", + "sphinx.ext.autodoc", + "sphinx_rtd_theme", + "sphinx.ext.napoleon", + "sphinx.ext.autosummary", ] + +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), +} + # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -48,26 +59,28 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' + +html_theme = "sphinx_rtd_theme" html_theme_options = { - 'analytics_id': 'UA-140820927-3', # Provided by Google in your dashboard - 'logo_only': False, - 'display_version': True, - 'prev_next_buttons_location': 'bottom', - 'style_external_links': True, - 'style_nav_header_background': 'cyan', + "analytics_id": "UA-140820927-3", + "logo_only": False, + "display_version": True, + "prev_next_buttons_location": "bottom", + "style_external_links": True, + "style_nav_header_background": "black", # Toc options - 'collapse_navigation': True, - 'sticky_navigation': True, - 'navigation_depth': 4, + "collapse_navigation": True, + "sticky_navigation": True, + "navigation_depth": 4, } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] html_logo = "logo.png" -html_favicon = "favicon.ico" \ No newline at end of file +html_favicon = "favicon.ico" + +autosummary_generate = True diff --git a/docs/source/examples.rst b/docs/source/examples.rst new file mode 100644 index 0000000..6b3a911 --- /dev/null +++ b/docs/source/examples.rst @@ -0,0 +1,44 @@ +======== +Examples +======== + +Uploading a Image to sxcu.net +***************************** + +To upload an image `foo.png` located in the same directory as the script and print the url: + +.. code-block:: python + + import sxcu + connector = sxcu.SXCU() + result = connector.upload_image("foo.png") + print(result["url"]) + +Parameters acceped are + +.. currentmodule:: sxcu + +.. autosummary:: + :recursive: + + ~SXCU.upload_image + +Uploading Image with ``og_properties`` +************************************** + +What is ``og_properties``? +-------------------------- + +`The Open Graph protocol `_ The Open Graph protocol enables any web page to become a rich object in a social graph. + +`sxcu.net `_ allows the following properties to be changed for changing the way it embed in apps and websites. + +How to use it? +-------------- + +Using the class + +.. autosummary:: + :recursive: + + ~og_properties diff --git a/docs/source/index.rst b/docs/source/index.rst index 11a465c..8d69fda 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,10 +10,22 @@ SCXU is an API wrapper for api located at `sxcu.net 5qR7yp!GGk;2 z*_St!GZCS(glxli^uFKw{jcx(u5YgE%(>3F&U4@Q^Zb7I@4nA-(rk~L@p6fAVK5k8 z3v&}Y^xV3AaA48@YL|y4=xIlkk%a>X`n$;Cn~Gj@!sf0~=ruUMNQlv>mhg_3G|{#;ApLyr0v@`!kz! z%&iq}m!ke+HVnyZt9X-}a-$^rj3jNo=me3t;m&Tx|CAqU$sHll4h6(p2mNd+jl0HRNKc&P2dfD8gNQJO z!cyhYhm@Qn98)d=s4>S7F4ML-Bowy!4izDa}plm`Ms zb5#$HWWPxE(W?g`%t-mu-zHpopQKN}kaz0-ZK5cJP2HejPz`MV5VfLxN)iOHt=&B2 z=WyoOK4AbFDQC+U1k`hFS^t?@`}Xsp#wFd2kJ^>F&OenO9GitG_Rgx$ro&}BR|iD6 zXKwsbJdj?IORPZ_4R)8C=j!F$Dr_+ybo*qSNRL#oD^N+t>;KGw)vgg~v$VF8f@9S- z9~;;Cb@;M;nCvh``vXz$?3bOJn>Rgz2X1JG41E95H9KY%w|*AWhro~JuRW6p`Spnq z|LEd`c-=g6>jn=_z3+j`P3EF= zM>Gt!0l3%kj0QvBx+T#;+cfy022#ivZ}Ej?_}kAX=`E^+w1L?tZxI(=kkaJwW?Go+ z_v6q;p(qG&6R;X62}%zPl~7q;bRS6#YaMCQDA9tNhTpLKHZc6ea&Ywf&W!cUKYu>Z zP?-E1vJ|Qdd_kJquH2%;+!pU6clgk6$oPF37~vwqge=2-AC5Fi%6-N)_Q%G6N0U|D z(w=v($2_m`9mXfq>d87&%c8%SL9d!v_Q7d>VK3gh-P{q%g6p0~*Sw3c_5f-i9CqWp zvDvA+CiitNXUD6=}!x6kvm7W@8}OA_qs=wKm$^j zv`k`@m!<3F zK3~2Q)*7|Oi{b}`a%S&=veS6Uw7*h5Ahv;a6qXmsM^bkKDLGY)F$;BwhkOBw=Vi0o zfs^+=2VJY5oD1=XYg1@m#G=L1kojq^sv$Z7h4DI-5u%*L7H%AytprPF@~-7$|H(!y zy%_a_$rgi*Ohb*s+wZ&Bo9YiZaN^W|O8Rnv0D+rZ(k7AWh0>B%FUm6YFGq^v+46&O zKd}PK9~Y0HlvO3thWatUr2h!9g9VpXnJAm;$^q75uylV0X5vG+O%ly)e39CRbRYNi zfQO$1$HI`-4!I4fE_98q0XVlZ{L3;~qJR?@sqEF|8`o$WXS=AG_T?Vx4Hvp{)Em$l z6tVy$>~BcsD`DFJQPABTOL`Qf0AX}^v(?iW(fOFw(iGzNZHugU%_bHduQYji0eJ&L zKPADsiYn90b{dhbn4mk1yQc#NzPHuvxANS}4N;mHI?kp%E;3 zew;vKxXDNt%3Vyrnkhfu4?dr?4Y6xt*%jIwWf7gJ6)(Fn+JUq-TP|rr8 z(W`>>qR_je1ng}6#U3jt?BV>c`Jvj)NWI&fHBLL;8!=HSjokWSY?@2WNu(uUdey+1 znisq{OvB{Dv5h7D4Z^r6OS}<(G+tUGQBN#}HuUPjB|b~Abb-29r`*x4)s zo`f(Yq7!VAYMn%zd87#$X>N_r0l?@=kbm(`W>9qu(~zB)tPFwi#AP@;UkNt(IU)>t zz59-si{IHh*cSj_ZDPSy6;h}o{>mUB?nslNg5IIyX$1Wiq&2Wm6u@~70Kjw=7VeJu z!4C*e&3L+gkw<1Up|=c7igS$^h1$`%3;Md@6!d-;aCy{&%)3o+${$9dN0A* zpRWbK$ADU2+>z9dV>`saFEA$S)81k(9DbkBsU5hp()lhy#dxX!za7r(y?QP(x5~dH z4o=0mK1-Bc{J9JIEN@MRZS#)7D;oBQh)v6c7+DN_15>JhNspVU!QDsKiL_Icm6%FK zVB;i*M|FBv7M+*e;2gj7z=ap#*wP7MH!F5igjc5geRO!uT#Sjv!s5ZYfdH;$I2dBZ zE%V@Z)kINb3Nzm2scDe&v_wJToy7`;E9y$uYAfMp<`Ns}YDoQ^RRk_=RX^7q2A6A9 zpXRfrQLR(=S_d`PWNjiGefW?CpF0#ooDMXR%y#@`zsb%!`R4EMP-H|Ob3=j0@@ihD zSr@hUMZg^ZiS2x4nw+&pPVKWKn$=4|NKf`0*33blSjGi-Mwh|L;O5oZc;Y3;Dl=5j z@)nfiW%YB43HMb?+Yo*ROm+|6!>OXRNAw9V_;wgiGZdQE3foPd^8<)wARrxG_Lvtm z>@b0DrGDfBS!4*I;%JW~1e<89LstruhV%AT^`@2}me3wHQ=eZLGwJLWG}9S--$!wn zf@`<4v>^wW67$F#pG@3!B6WWP@i?3Xn_#t|a{xeEG7A@{Fz}Y#P@?M(0I0+YGFolQ z0bo`1BeHjX?Y=0u7|s7@J6t9EGTG;9AiV2>1X;C4p^4Ge<^a{nTkFFn?~@uVQ5c`c z6Jt$vAWH_kx2|7~8+Rk;2&xbs7nH&M%ix0MOX>+W+^vRw6E-v7;Ds^~vPm41VwkyW zd_WL%D5svllA>q|uh_u^FR>*Dlw3(qPFlqpNrcD-Pg&v9kyN)Mykt1+ z6AttR3xi0oZ4xh87b<3R+K+Gyjo}#vmVFA0IiLKi18{b^KZ&h!*dUiGFcYArU5QTI z!U{^c`T{WX=5*npgRuaS*rO!?;3n*HQChU+(F_G8&#p8^hy%cQI3itBjw2eEDRswn z?;ulp_9Lm^UxY#nf`^2`CwFS}iN?M9ZovnH$bohWG{&#G7^pX;bfKKtc91bAGO=j? z5lgxkcg!Ze>8dHX?wKScT0=TQa)S$JZkpW%kG$se)cF{}JAis7OtxU|OCfa|7s%l3-)ys;e1 zENoC!(Q<6IjIpRUdKdEbgk#^|A}A-?u1zd+(~lGE@|Hc262yT^8a@Y?^UAgy4YtvX z3D??xsDMbb$tp4*6_ErzPs`&*nIW?a>pG}!`e+p-0POWf^);o44|wRp1*Pg;(D_TU zhGQkI=;6|A@W73MR1Jp$OQ#G__CLJmbDom3z8`tO{Fe>+hKmeRLQY#N%%(EmsB?76dL_(b<@|=6K{4 zXMVpgtkpC7;c8JdSIx||0~ZCr(74kw(afm^94WHZg{r0v_&U21li> zRfwq<>L#LXDCtH5Z5gCO+cD;Nth#I#31wt{rLp)`wYV9h?YSo`0_HL>brDYc z4&27zdTW%UdI%X>UIEChPGndQ1Uhhc7EQ;mJJLpts@}Tg=r0QbBT>yIdk1akX&Z$@ zvmd=IBbv29es9N#+ck4icMm!zY>Gw6FZGSxu0OCw+FYDa?s;_Z`aO^PEM-Ad80vQm z-b2yYWtZw$kfE{v_HbrB*WysVO65&S;m$mbOy^TK>Ma)^bjnX(52gg3L`&r1OIW2C z47b_bE;~O}g@d73k|)Z8-4J36SElU*cAybk)YQ@?NM&-)MB~b!Js^-9{<%$TpmLYwJ-m~xnl6xCayV2`-yD~M&PnJ9BUQoG=m19!pE^`hX% zCYE~$~QD`WIZ~zYrIcwXGh(w+}dvXH~*05^vGiET`}O zj*X8w)%icRa;X~4Ak23!fq3$yB98?W7}vNkz8cxv)>d5ql`We2T0<|&a4-w08@;(p zJZp05?n$AEg$eoe%W(lAl%N3$qrJ1qa5LR|_QnTVSJsbnoFwBVyqH-|mNa4mK! zS1RGz$56f>N1Ao?w{!_>Qf42iER&Z!gO$Oat^K)3YV6bJ8Q(j6R2o)@S534KOPiBMb;(k$+*0V=a+rPZOq$zrEh>4@gkS_OaK>54L>A!U=`q}hyoa9*1qt|2{ zx&cr?cUqZizuR8zjcQ+6;aW_LRK8`Ql~?mw!OjZv+W}B9k!nb<9FXci6F>e#Nlxm* zs$&W6aectv+$pPiu2fsD7uC7# zczRqIMMA4azKRL8eyaa1o1mW{5-}*NLwYG5%_WF<1udVtY zd(Hosg>)ym!Sgr_fetT87(!qY`PV#Rjku@sMW%C49 z6SHK$;BmA8FN*hJ z4)riJ+-0*bA~uhZUd>6x{{AkNyFuvN)LNKpaya6$MOd8Ba9{7`Xj|VJ=Tdb)>U_dp zU+uEO>?wS&X-B?_n1fIBb}HJ*K!0benGRgF^(rblb2hFZ!PgW5`>z-Jb{xY>V1<(g z@-v3ygc7&&5WwOj?mETU+6VenL?#X&CMm9*XKhQ ztEO!stfwlLIChCV< zn>ben(TCYS&q%|y4P+h3_&M`sx2D<`?IX-FgPS|9!2A-+q6;TJh*&8q{;$-1+r$C@ z8gw3TZ^j#<2hth09-+sKZ6t8DncaLNzI9qck)-JEuEbP=z}sErHu1#Nny&0qBc`Wr z{K1%}m(ZTYF$KsGARj%Wq%+aw4PNgoY_etV`t*77^9!NLDpHrQlZ3H9Fn6dLM~UWq z@shwg&+1Bho%OA>|PW9J98f0G7Zemu_3zM7zWJXxR&%f$&$wD}8DM@#r=}C_4Z#9IGm}0q{cU{8dT}|6p!h zmEsi(h=3iC_S&m;q6irD{~5N_8kp7}7W%g|+Iuwz7N2Blr4(HEMy1Hv_9zA2LXo?> z-4V1Qp25?Tj#ZUT`VQ9%7kP1ESQ087rE&eiZ?_wTQZk+*fR_t+nCaDUTj;AZtyJrx z#lAAfypUT1i0yXe?Ju2EC@B+IsKJu_Pdn6OPx1n9P!+I{C>B)HE{JrkIN;r)?%wl$ zMh7~x_TTH2u01fVc-Dokyj|N&h{l?S?z^#7V@cj@QkcGsKKltyQCTi>M;4J&M?y8Z}!h zMkO`USTT#x->1*-_rAyTyvO?<$NNX}$&n+u@9VzCd7bxp#TY_0nJ!$v00M!Sw6)Y8 z1J6F-6-9p@c;8A}e-AtuJhd!*fM@gH7uCp3es18yHH5l30_Ne2K-zmdfsjZf_^G>_ zkE6Y(6WGJs<=y6k>mU$!v$mRwv48dkJRk|)6YwX*!_Q^QYSk4P^&-JZ!0Xzr@OXKq zUMJ6J!nt#Pw9m{6*SphTE}r9f#JTopZL&O} z<@4≷&9`5^+dERV;EfN!NJj780jy50RAPlh(s`vNgI}@clCOm3EfP4|y~H44F|U z!=Wp;Stm=DyNAyGW1|X#7Crp7Dl}EInxJ|GS%j@5MNT^sE<{{xQlbZ|tY6DKr`)Z! z<(pT^6+c%Z$<JX=CH>Tw1EbJZ{N zJEQ7X-Gxhoq3m>aghDPhSwR)(oTVSFl-b<|9Uc#fXf*%&M2-HB=OrO*8?J-f<3*MGUt5{m&h7BA%XT zd>`c;7uQsISIpCQ?kFEN8LZ9u|Jw7Y2-e(chbs2!AM(48(Aju5P$x>KQzy4$fawmo zm9x_o_X6AEY462P1#b$JVIIQ`b8K5sbpuYKy#&)~yK+!=3#6Y_3$v~)Jy-ah`PXGT+{X6z;@Me6u=JKU!px^&=dW}d8mG?Wu|1+InJqkQX%vK~PvT9uCr<(6cicY>1$kH7UKKh;d~y-HnS zQ1=#%w9ytZ!wGiOWq6bddIYIZQm2P`!`r{iykJbPj8eyl2N-d_LUGotMEdd7!V4w* zIcsdrjeZIis37D^4*MF#dAC$Gwfopx-P9f9(7cZrNbb@QD1ZgO|3$ccoOKNxrG_aD zQMcfl@uP7l2V8pSO21pmoCaU4!@YgL@pr>-HD!qxD5<7b#}P;=QY~mLRb%ITXHTvu6ymfY)`1>5 zt8dRi3P&*mA0i|YX7XUoa0!)15EBSuz}1e{noAH)?(g_AbEO;J|I<6<(mI(y znPn!X=5A2NMM#*uIMwerfwcZ&avX7FA%_^)SRI-W(Y2}UxjZgXaqfFpR8N)pT53}` z@hI!v%T5A3smH!Ejd?tmFM}&S+gfEPO%FUp*O9wsp!EC|LdVIfyGOy)I)3jN=RaN_ z8@u!-M5<1r5V15Nh1!_XqX@BtBxu0RkKADK1fVu0xJ=H8eZ)&H>CinLN!Df77%t~s z(GkobMcNtc38Cv$A%)d<@c5f0V2zGvoW_3_d^RCctGNGwYTW(j`bDDg`*9JsR=d~_ zNr0aiy2~YOAOf3WA%I6O=F4UJXG$@6<0q@dq8r}yFCVJ~xrZ9p_27b^PKYFr(~za7 zu+hf|sW-1rpL42teJO!s;)s5HtOtO({|y;GHyW0YvC*g%4o<%o$|fmss+3bx3lqWh zL<^$^-%-Jchtybd={*?Aq>=Y>`(GZ;SFBeS#hn@GKZ2yqWU+JPRHK{^hi{d6=YWfF zueGK#tRMo%*TzNadCpKA+&R_5zLS5;T7~&u0W1sOxf%(4xA#@YOY$J=|6)Gi5|T@~ z*X4aD@ANEOZjQpM&jXk9aL2xY;ma9NviFudJCMOkZxkR-J&J@LqgaHF9*yr(^zN-3 zQ8fTxMxOkCtUQCuo%#2b|HCDs%9K;_V2D%yproquj9}8`TgFowh2A2DrgVl}SX*j+ zeg33)p>zC~Xd0%1wJ;a5pcbnTzMhV0mtOuaF;;`+yr2!Sx1N2At+bj4OqnT^GTiz8 zRu1J!ptyN~-rK$Y^H+Q5M2y?iV{V0Ua>)oL_`2rK> z*Wg~{hq4i#K3L*<#<&Q6uXyXidZ1D3#}CZ1i?z&$e+DmRzSW}1hYdDbRvzEESe4hp zJT^dIgkhBnL0nY`U3}e|Yt*Y;^zPb=U9k0w#&n(a<5LE`9(uj=ULzOq6UF>_?U#;rNS@87Y+`O_Hsli(*9n{n5TzHw$>A z!e%S`;A9;LgoiQ2C+dA@Eo23GcD-ucUROOKe>*$`iJU!@ox?J2o&BZ-h3U(p6+z07ft z26=4?`Qx?O2ydFs`?@M>*|~+NK@Xb*H;)Z92S|(ysu?{|zyIk2cD-oXeAMXG(S|Sf zATq}vZ&e}kd`i|VpH$tG8Q(+x7TI(yo@?=b>j@n0OL9$8kqhys52X;PxE7^BcNr1x z@E2}>sxLmz(Z?=tNpvJCAF{sbXXl*g{&J6_;#s#0vb=-M7Pr)ysF;F{Ni%ZJ^MQ#$ zdE`isV)pOsa)t38URP+WuFY8lGCtO1US-lmE7OHlnKt+&SDE2^?zJ4&4IcRG zm8kDpf{%Z%U~Jpl`=zXulJXpA~!PBZpSR5kg}V< z=QKd=0$b*>t2_&d(`%`NEFkRCuuQaRnmyvlJ{ixP zmpA{jmRc*}k?8HCfq6j90pwW8MO|@5fb<9nt~cuIfzw}KFo9Q zhR-F}w$8evKw*TF^V>TTEK*gh`ByH(Lsu<94{zsoOPu*A;3u@7ieK)M_wKqhLi6!y z{Hzc86MyqCzooT%#m$XG?Gd@A{|RyQyZ&!}t*ur9Wez6DB;PBn2MqlsGyA?C=ne{^ z(de1@=}JI<1Cy|rEF4LDH>`GLetDa8dR0zQup_E+b(x#-um=RXQzj#K*m+bJY-4q2 zA@nd%ZGdU-Fn$SRi@Ks!DEDWit&yo#pP0~gn5ZZhg9A*Zvz7E9NyV)8g|CX`Shwrr$b^2f9G-2#U_;a` zN1<=Jy}+43SOq9%%)vjau7oJAGs)xsY()M+%gg7lTNY=Vh|`PMRm%1rX=H;Hap^6q zp@AUM!t90HolHEx9)*rv^*dX7(c+Ag?yEeVah$s~AVpoL7{X{4Vkg5GIojYQwW4gA zh*N5!s?|?hQ;>?~L6M!}8TBMn#mY+Ziy5DnyrTlCwn$~m-xYry_0T+Y!u#8O6T9Fi z7e*dnZxB?6UD!Z|rp|et1v*_Wz1NhNvESY%mW1Ccb0~ApICtr%jpLafWmjGKkN3%E z9m}5LP2Lhy)`O##1|Q_9(`xOHW0ulhvTRvjYyu@hU)OV_55-v-_o-=YtmV{yb4k|o zb=J4~kmJYV>mR!&lxGJ+if;8qP05Zcho7s+?ftbMcd0D?hofyPwbK}VAaiz4;@Q4I zrlhh@*pJ0=nLCoVpLUR2I_v4K!a;T3<_Z6>2 z^+B+VIu;GJn2;As$jXCJnjw`pB@l$dMXt+Xx9>@O9A?OII8;2EpSmm}>$x0c8bR-W zva$L;#DopC^ZohN8ig8eFfJGJ@;hnbGe-P+NAlFk_I68!9VFdQ(6Fo1^@I_6^8v}? z2l*3?#`!nn*qE?c=hf3*PY=DAxc$en5~mMu-@hBB2LC43S8{bN^$HTY;PZdRTrFs! zmFzP!CSsbaL)CV+IJN!7tp1i#4(jgr0OIZ79nzHD%v%lvWp&&K7oqmE2jq4)VyEHs z`LOFNOnbk#Q^h!trN6wMr>Lg9JaO1oND171I{)Mk&8pRkeBP>16D&&i;3%U+_UE{$ zsV|*H?VC!20$2n=Pqt>#C-BxRUr%!a8Z|F`XYLrs=l=s1+Md+kLb4JiCkHLW>Xs|_ z6&g5ukay0{xudQ=IfZ-rzN41deHdeCvf3UmBV>1VffrSF2hge{Z#+nCXy3%D>}M zulbJ%Npw1GS#HJ*zPa-H_jU$Y)5MzHC4reQO;5SFWv#I=T8)V%JK#am&d$UiuliFe z-Y{}a3K(u4QdaVAz4k*0TQ0V8w?-dBIYsQ;D#6?BNju&OX!vvVFM_@)mIctqVlOa} z9VBk6z(T69jopcjR#Xo3V_iI2<*Xtc5e^!WsDJKo)J-v*75uRsHGQSfT6sCGcKPZi zx}BwUPiQ@K`5q{*Q7Kj?qh1F9+LWrNLFM^HLwu%xygttcT!hFZZ+ANpX?HhB$*nQs zKD^QB1sA*vPMI#-%g^IWp$S)krS>!?4|bsRXHye2y!e?0!0MbZ{Qz8SF9=oKlxz>G zpKqb!wE6y$&4bZ_w3QH1NEM^TnuzjMSgHSR-yf@?Ho#cg=5;OiciWU)knh(t?8fd5 zBa<8I!J^@>wq_!#IvAQMC6R0QloPR(bf2mqA6cZC9l=@I*TcPx))OL`Q%!Tl1PU>? zjafY`v=wt59BUmu>fOrJ7MKb4Jh*Z{htMIf{XsMNd(7Tj{XzbNc*m{LkK>VmE4TfC@rmVtaa`FDZE*2A+rs zk5KG*pf|5m)5}#MFDZKDs*_?hhTKY2r;1G1j~o-(D<)R9oIwvy0=`b~3`RbNPh-W3 z2Mukmb^QLpFC?@=;s;Qm$kEH{a-8GT_vdpN%zdwlf=6n%iK%kvr3q0D7U_ReOW-^n z1}iK{DEJIcF?M0oXm6&%agD@X8%q2#D0>i_nO54|MHyuR^}ZBJL*+hL=imHCe3&@x zKjHm3tNC3hp@?@s9w#q&tx#f`IH z!E<{^&Zgkp+-MxBu+c>1Nrrb*t%?w(k4(qR5&c#s)qdag1{ z#RI?5sNK=5Otz_F4X`^%xFq_=+r;t?^3<`^=vQ`4areHBX)!QFU?7|^*0GnEYGCj6 zIgH_+PafrTZg*U}U`XOm%W@;LxW(97XJPa02se){Y7oH99e|ee49@X+>isz7ZEu20 z!uyIKxs z1$x}i&N|T__WI-YT59Ro`M{Bmwf}wT0WP*?M8ZbHsnKhnQ^Y_cB*343MCmin)WU3x zR#tf8d=RY-<-5vWv;2$cFYFw5O8SbdO!J*wxU_EK_q{-1%uv*fTyi@>)nm*yCVv0P0bGi>A$oXs~)0Mf5XLhM;=r-l=8F z2uoqO2QJkp7n+)!p!2>Q5|SJsZMr5TO_`hCTJCg^{Ri5 zHW1j}J8hDLNXBf=pPC~>=)Ul(-9Gylrc!;n*L!zX6tenx#SRNT_u z1Z|c!xV&IM*Zh;|YuXbFCevfB0M2??K4W zgw05}N@|+s=;Ta1K*Ir|7({37WsuNUwH3v!Rx&U;XBioNB+&WmSQx0z^&m2TZiuHW zv%CC8jP7ABN}T8lZCmBdtFGe$08}o-lYRuXE3?PVeg3lj=TK^seWM{O%f!=nK}nf< zo^t2=Ig_Ep+(=yRTlJ4S9k8=ulf}EC^6e)=L47snibI^(Osyq(Mo!m3pdTO5ZCn#6 z!#A|vxmPLquyuod%4oy-TC3Q|pI&I#%cIgYnZ&JRdE(M1KNQ`H1#Sz;XWCrz^RE`z zJ`7-i);1Gm3ZETu>ueOm8R6jJn6{Q1sv%Oe?k{$p(CC-Rd@Kcbt^MHFICjvo zXcH?>e)v+wyt(?a?`{cj{T>TN(5Slf&SNi)w)$~v1Uc5totULWuBs*lU%p{38RQQC z9INU}fAow12XP0e&$&O3FT?yA~?hV}nP0FxT z{kzKw0n1(^j9_B;!VT|UFI}pNF9A-=rH&M(dICj>b?;NS!?LJy^QoS}0XI*FM{7M@ zC|Qe$*nm?)8K_9Tlk8gUPezzJ_`woYEc zH?dswGKN_+Lki5)jbQ8efnUNEEI-cUkrkP`-1J^NY}+}u&0LE|opD6v3AVL|k$8N@ zLlxHhxR;$m(V^#3PHuUq&D>{~89rvRT*h4I9KrK0eMjgfUF`2I{VOq<5&2>^V4APU zUqYYz{2W*1NXek;nC<`Cl!BaEakr|#$)dz}VT!{tVD|R9HJ^hzbwDANjQ3xRem7RL z(c2?oT8mylGC!q0GAooem zo8o@a-S)4>J0t^k4e1y$8G1F2fu+xZ6Da(KNnw%lxwe3~HW8<=OLGAaxRmv$C_rj% z{IhM&xq`85(Th8 z)XH_v+SVVdqAOi&4zRiE1r{3OTfoAkv{4}I@B~b0|`mcPoCsm>A$uOcuCRIkM?8-pwLK@mk3c? z?DjDrk|s(s$OSDqobFd7LA6-`z0M~YY9Z09Hzu<1a^c^tTEG_YEFT*SC>RU{->;W$ z5nVkUZBxh!_dd}Qq2ojDU6IHc-%oixC_j}1wb<1lj*1wS@2L7o270;VK7_>N?Eu>3 zn!p!$5o|K-=u*3hniJd znGF$J-!~GO#d%0|E9U~y*qz9(SwacF@TL+)SDf+i_#rKWxr9oz1rV=*xk5dRcmt3g z-vJM2<+zb2MBFC#Z}C!5H5zRK$!#|B3Ly#v|2@of?xn0@wVL6z9fi>$R^bBJjG*Bq zWmQN|FNWftb}g0!FstUdAicRvnt-~xmi=VOgM)z0Q4!ff2BqPg=gQgYK{l;UL4w39 z2d~0_D%1EoK8kwX1nA$^eHFTmWJFX$@Uwb0yhJ_XMEizX`$F%ak*Qa`}h zVOYR0i1pJig zy(^9$<-_o;I!lNXeSN}$uv43mz z46zA6>0Dvv^b3&!9I|ls-v?aZuTjM`2g8WFb$1d}Ay@XqcO9EN*HV3*Q1t^%qAn>= z+ECX=5v@Q#UdEx7R%^elrOF6U!f7q+@^7`B+xL0!gqn<_maaT5VRop^nM{Q&Iy>ZwGavlv7Z2@Q?qq) z%tT{n7kMOLnB#Ago8c7@BW8_FV{0vpF?RbPHWErptSiPI1#kB{)e%!`7q(fZw;rBy zvAliQ%mbj&QfUgksIpI-?x(T8ZV@B>Gs4LURGai+-Mn|&^H2cs(qiPi@+{p_;m^>et~438dtOvDnN(=DlHNCE)ul~-Xs1{h$- z$8)bS6FCP2NG)J#OyqKgLm>dK+sc{vJXkmAGJkk;_~R3z60om1SB-8SFY3)-P%EZ5 z9E!AA^{f+m`QrnCDJ?Mf`8(JIP6QO2`R{WV15KWmu@FfSt xxX2%xF$F_p#6Li5r10AV;BI^*;3oWsB@a5J8FE$v0fyZmZFQ(x`6IiC{{lT*7jFOn diff --git a/docs/source/reference.rst b/docs/source/reference.rst new file mode 100644 index 0000000..fc0e46c --- /dev/null +++ b/docs/source/reference.rst @@ -0,0 +1,16 @@ +Reference +========= + +This it python API reference of the current things implemented. + +.. currentmodule:: sxcu + +******************** +Python API Reference +******************** + +.. autosummary:: + :toctree: reference + + ~SXCU + ~og_properties diff --git a/docs/source/reference/sxcu.SXCU.rst b/docs/source/reference/sxcu.SXCU.rst new file mode 100644 index 0000000..a5bb332 --- /dev/null +++ b/docs/source/reference/sxcu.SXCU.rst @@ -0,0 +1,21 @@ +sxcu.SXCU +========= + +.. currentmodule:: sxcu + +.. autoclass:: SXCU + :members: + + + .. rubric:: Methods + + .. autosummary:: + :nosignatures: + + ~SXCU.collection_details + ~SXCU.create_collection + ~SXCU.create_link + ~SXCU.delete_image + ~SXCU.domain_list + ~SXCU.upload_image + ~SXCU.upload_text diff --git a/docs/source/reference/sxcu.og_properties.rst b/docs/source/reference/sxcu.og_properties.rst new file mode 100644 index 0000000..dcbf11f --- /dev/null +++ b/docs/source/reference/sxcu.og_properties.rst @@ -0,0 +1,15 @@ +sxcu.og\_properties +=================== + +.. currentmodule:: sxcu + +.. autoclass:: og_properties + :members: + + + .. rubric:: Methods + + .. autosummary:: + :nosignatures: + + ~og_properties.export diff --git a/sxcu/sxcu.py b/sxcu/sxcu.py index 3c128a4..04f9bbb 100644 --- a/sxcu/sxcu.py +++ b/sxcu/sxcu.py @@ -17,6 +17,13 @@ def __init__( self.title = title def export(self) -> str: + """Exports the Property set to a JSON file. + + Returns + ======= + :class:`str` + Using ``json.dumps`` the content of JSON file is dumped. + """ return json.dumps( { "color": self.color,