From 391f48a2957bbbeb272c53ef62c05f1363cd657a Mon Sep 17 00:00:00 2001 From: Adam Hendry Date: Wed, 19 Jul 2023 16:38:59 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20docs(introduction.rst):=20add=20?= =?UTF-8?q?introduction?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/_pages/introduction.rst | 24 ++++++++++++++++++ .../_resources/img/item_coordinates.png | Bin 0 -> 3959 bytes docs/source/_static/css/custom.css | 3 +++ docs/source/conf.py | 10 +++----- docs/source/index.rst | 6 +++++ 5 files changed, 37 insertions(+), 6 deletions(-) create mode 100644 docs/source/_pages/introduction.rst create mode 100644 docs/source/_resources/img/item_coordinates.png create mode 100644 docs/source/_static/css/custom.css diff --git a/docs/source/_pages/introduction.rst b/docs/source/_pages/introduction.rst new file mode 100644 index 0000000..34d3c96 --- /dev/null +++ b/docs/source/_pages/introduction.rst @@ -0,0 +1,24 @@ +############### +Introduction 📈 +############### + +``Qt`` Graphics View Framework +============================== + +The `Qt Graphics View Framework`_ consists of the following hierarchy:: + + View -> Scene -> Item + +where ``Views`` are scroll area widgets for observing ``Scenes`` and ``Scenes`` contain ``Items``. Each object has its own coordinate system. + +.. list-table:: + + * - .. figure:: ../_resources/img/item_coordinates.png + + **Item Coordinates** + + - + - + +.. _`Qt Graphics View Framework`: + https://doc.qt.io/qt-6/graphicsview.html diff --git a/docs/source/_resources/img/item_coordinates.png b/docs/source/_resources/img/item_coordinates.png new file mode 100644 index 0000000000000000000000000000000000000000..96636a4df9d4c8692ff1de6de212e39880a7804d GIT binary patch literal 3959 zcmZWsbwHEf`UfNgq#G2J4q@V?lz}5hNDPoh+*d@Dfs~Af(OpACN~9b}my|S0xQWz2 z7&1y2OhO5%JH7Y!{rSE3kMo}AJkN8^`@ZM%WUPsiE)xSk0|f;IlO9A1N}j8JjkC1m zXM9?c4|$^Wg6e8eRASDrk{8s@;9Fn{ikf7`qq{WZHT`3VwHE~ibN8=7$t9^DNg}ZW&^S>)?LqR3sQyB!?%Q_t4VB1Zm#OsG)I=AA4KE@ z;F+~9z5YZ40Nyu-T4wgDy>gx7Z&QAPiD!Yp+V=8bv$rYW!xz zHkh>a+DJOUWI5gGkpukV@J7u)1obhN+fjRHv(nymy-Wj!-qz8QfqmKZrB6_#b>00) z-Q_H`pcbpXo~Ni#85x;Aanm|yEOYWO&}-RnrK;nE0sH->Hcd}Y4<_lt4Xr#Vm2T2` z`sCqlVpYfWD$VYWy^16*@Mb?$GIJV=SMgd#eV_wWJQ zuCpHRF5o{X&0U5)+FAbKps5)iQ<0R!>^|QespINGFYu+gGf>R_mBM_q*Teeii{ zE^H68jyyf@DFYSFc&H_(wSPkelQ9&dz&g>7CqmUOo@HDy~DqdsT*psA}1 zydiwsC)yKT+r_;-HE&lcSAWHqWao~}0}1ExtmY}Y%}BzAeC(@=i?w?va((fuWCMuB z`F|hL1s$DpLp(%f-U*&6FE0ne3=D9g_^3e^OjolAW zvrG!Y=@I1#zpq_8-ngo)Z2RZop*GCH@Y?MPo27d|7XgsB;_1Rg8@qLZ@s}re`*(xZ z(4}okbAh7=>vhYc7oa**_5q!Y6_LabcrOf`%#0*P^Ek##c zsNIukIN6y}x^y(&P_*;mk&7(QE9l-}YXWjpSz;NR?|!)f#k~cSOrg4ThT3qO?$Yff z_;Lvpy=d*6n=x$BD_su^F1aOllDS~66anBb2|}If_bn`tcBn#l zeM9!=>E0#F*R9#S^=+$ZZM{(_pq@TSlhsR%rX#g}dz-CAa8r+XZyQd2BMOmuIGPrd z#}=q@&MCHcE-`Taj5vD*>@@<=wyD8Wvn`fsm$vrx>*M2H!@!@brG75a9ExcitQG3I z@dxRRIIZpr1_lOdVrCOINChZqDGK{?U;YY`Weh7Vvf- zw#a{?z(Ecgu^bXc=Ml$0CcWM&_8BC2?oK)H8Rn~jeD*i*ej7uZZC2_R;Q|oLmlC3- z9IndqR_X?MILiJ{O#G))+4SC+lGyPouyU(57PGn{V-aoTW%ZHqir8d^>6>)A1Aap> zDn3R*WvoZB=fnfHs-hPkO+`UL@>KF&BKlzw*Tg?^E3QvB$W+nAdC_R5-0R~JA=?s+ z`9(*^92$+L$9{({-%*wr0juJ^z-#VKwK51)s|lgQmxr?o;T39?ECIZ0W##2t59}{G z6kUeqQ#M|e?NC1%0+>A~xs+K#$0o)SY-y=SgqJNg!tVx={qOVFSfU0CuKZDt;56Mk zgetqAh_|<(Y(4_t=7$GjRTpM_=Ysm%0iQs#{=^C+Rl)p^Pw#+46ndR*hJ!l#sJLoeR&OQ=k~$r-%BZUNkmNs61J>LX_~x5p%Xyo+f^sr<6? zE?igERPo*CN0Y$Ad7t{(!?{4Zk_np@$dWr)RGo zk9?k1c*HJ~oxRhT;lh}}Bme#XN|%2I&i_uP6R|vxs*1Q-VSedjo_sj@27=>dD;=?B zRN0G6O1<0E>{gJaDdYvT7!cY`BgrxGR45P0RfZt7T+(Xu@#lWTREJEsuo$oP$Tb4pVuYb8HK?Y*4WXLwWO zx8?py`&Ozgx7n5-H?Q%3kaR#5l$8zo%}4SeX+t)<=)!50Xr`S{PmUo!7F}`Gm#V8Y zAq;2DUCz9_6LQ>87qI8%JX&%Kvp!W9jzLcPOy_XEx8N4!Ux|~c+-!865{6Zw(E~eu zs3zG-pAn5!*X^w;rxPBBl}AxrI4ug;mRhW8_lq{Jl03W^Y7U@9ICRBiyNSp^$)>EgB5ElbEj6PL`# zuRn8?dmB|pGVwV{%gBW9jX96ZZoZMbx&rYrOc0lh)?x>bak)ylC)ciN*c-T<@ln2Z zjk9PNDtKq|z4h)|dDXHgenhw{`exkAXrW-7bw_Y}-MxXdQE6=+$t%*7llT^&a<2~x zlgg81q#?=u#C-w#7j~>8Pi1XW+=pFUTBQehD@d zuT!|%($Z2tSMw>Dj?uq5gk)iEUc@73_iR@;A)&pcp~2$v>}VZUjc6Zyuq51w_b19? z0d;J)HZxqRQJiT~M)TU9-;sI5mRLOAVbRXE7ztowGHH9Ra(c8A zZjmXSaZJNw_l4ZDtQc8Z@hNMmfo8T|Et`x%1Cvy^Gpo}W5i&| zN>-i;+M7j_OQ7l2)00C!>9c?Ket%c2P1L5uVe)tX-KG>PV@@fMa%u#yFOL|xS*Fm_ LHqxrpa76wKkkFwW literal 0 HcmV?d00001 diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css new file mode 100644 index 0000000..53da275 --- /dev/null +++ b/docs/source/_static/css/custom.css @@ -0,0 +1,3 @@ +#qt-graphics-view-framework .table td { + border-top-width: 0px !important; +} diff --git a/docs/source/conf.py b/docs/source/conf.py index 6db6b34..f75d7db 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -53,8 +53,7 @@ # -- General configuration -------------------------------------------------------------- # Paths are relative to ``source`` -# templates_path = ['_templates'] -# html_static_path = ['_static'] +html_static_path = ['_static'] source_suffix = '.rst' master_doc = 'index' @@ -68,10 +67,9 @@ html_theme = 'sphinx_book_theme' # html_logo = r'./_resources/img/qtpygraph_logo.png' -# html_css_files = [ -# 'css/custom.css', -# ] -# html_style = 'css/style.css' +html_css_files = [ + 'css/custom.css', +] # String appended to project name with hyphen in ```` tag of individual pages and # used in the navigation bar as the “topmost” element. It defaults to '<project> diff --git a/docs/source/index.rst b/docs/source/index.rst index 609cf1c..7a410af 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,6 +8,12 @@ A pythonic interface to the ``Qt`` Graphics View Framework using ``qtpy``. :maxdepth: 2 :caption: Home Page +.. toctree:: + :maxdepth: 2 + :caption: Introduction + + _pages/introduction + .. toctree:: :maxdepth: 2 :caption: Contributing