From 8c6e5d83f9427cbb40269a51b436788c02466e00 Mon Sep 17 00:00:00 2001 From: Marsh Macy Date: Sat, 27 Jan 2024 08:50:39 -0800 Subject: [PATCH] mkdocs-material setup --- docs/assets/logo-osr-apps.png | Bin 0 -> 9357 bytes docs/index.md | 20 +++------ docs/main.css | 24 +++++++++++ docs/osrgame.md | 3 ++ docs/osrlib.md | 3 ++ docs/tests.md | 3 ++ mkdocs.yml | 78 +++++++++++++++++++++++++++++++++- osrlib/poetry.lock | 51 +++++++++++++++++++--- osrlib/pyproject.toml | 1 + 9 files changed, 163 insertions(+), 20 deletions(-) create mode 100644 docs/assets/logo-osr-apps.png create mode 100644 docs/main.css create mode 100644 docs/osrgame.md create mode 100644 docs/osrlib.md create mode 100644 docs/tests.md diff --git a/docs/assets/logo-osr-apps.png b/docs/assets/logo-osr-apps.png new file mode 100644 index 0000000000000000000000000000000000000000..9c383856e65a47b6be1c857733c340accd43419b GIT binary patch literal 9357 zcmaKyS3F$r8|@P=0cz@i?@`&t+yUxuEBm(Vq0Hd_x1H1l)CYUL2NQAii;notM*z5 zQb#{yB#T}8VRi8J>#csYnwpx#5HT`1k0W*o59Y!ck;l=GCX0AI`0-h@=N3_zjA!%g z&Pk?fVZLHqU0od+2?>;tBD!0Eq_nh@fsU?vX3MF*xuSxPI@-g_%dd4VJUrZ6V%uHJ zm2qcli;0=p$;nA_qpYT+q{O`X17^vLmOx5YMMXt`7LSHBqDwNzx%2H^TJ|@Y1ZVQ` z0zUhH%=O{o98s)<$h^8g@BJKZ!U$#aFUSFi#CtvJkm5`yRgS|79NFSdTi zo1C7!3N-oV@9_=!LuFX?cwi8vL>?{6{qEgem+Df1bqF^#5-J)?Q!IGaiMYorA!z(x zmq7PtW#-}*ajpOh%F=!Im6S<>G)Y0RF z(LhT14uk9!P0D2-Nn^_R_>D{oTrN`$rLiaKZ~p%9`I~NSHI(gGjnKMdn?a42TUj|| zS1a=5i7O)p&7(FdF(jU)p45wX%|b%J88uz!n2B{LE^;7)kn%8O{1YoE+YQpB(Hq#Cq zR84qe?(RFPXiI}(0SlT00`6ub(zjoRN{yIngbhhoB8NDA&X0(S{$LoX`~L z83wCbMTCbFy`;g7G!K)>^_Ji>p_G4VXh@{R&HJ8CNMUUZTpscNPCq8;LYFyc#xAiY zD8cMdVaLawDDCftW{c$9sY5G5nFDZCihBj620cAasFK-+`KRyAw*@b`@Sy{VkG=UN z1f%fJ4w=Xlvp4dYl!Bi8i z5@r9g8z*UjDtpq*7N1i2m!Cg>esV8qYis-WRyD6VkGzmjX(MgH#F+UM=J~ShY-VsH zw58z7+xQxS3zvTuJG!(K4OLR_;~1WvE^#M9OFG6s`bJ#8wY3F*l|_hr7jD9d8Q!dX zDj-nhJTKWiJBTiu**XT_UK;nKztz%E@Nq>&*0W6>X-00!va+&l6t~yys}VLCo?=<1 zG#f_12+MD{+r4 zIPShpX8&@OLOxG_-Ip)#nZ!LYu}thqy;e2PvIaFc@FZGzsfiI09*sr`N^%gq=2_-A zOlD^0%=9!f5G>^+_B9_-dFl0wv~ACiu~>)g^>w5usT*V3aP`lflYSy+d;8IqY7U8; z%LAW49r>j}@tv_V7oxbRhfGPmV^dRvjW-VAbMP1=9_s$nm!i8(DNmMHU$E3Q2;(K` zVoOp+Y5THmdo2p}15$qCfcIa+BTJ+-PYA2}OZk#KrS5A|XaO;jL z{L`&20liYH%V!?zIz^+6_LCJrlsh^)z}=c!1A#BDOERN{oFzgDO?5j3-WS^bbPL@V zR?AdnccC)H%0SrCRr5HAMEsXT$=VbkCP^zkjF^teZZwZq`1^VStc(%*9Tj(i62}uR zM$E75vMhpI?}=sW zlkflFayVZxMLlI{RojZ(uy;7vjP|PHJ^T#|2}8`;;ph{qzdzF9-F9MUTylwS6;iBTkz>tXQL9q=U6m`FOweZuY8;uAKO05y*s@n>2yKZ*` zz4;Z1a}d?)*%HM%$(9CLWQ1(WT(tgh8Kc8;@Su`MEFZA=4G9TR=c- zA|%|b&y_7f7K*)u=C;GBU1MMb&5WT zpTSEFWt`C~K3Cam@wGBpnVfF@3kwUWyf5kL>4T|m$$7bDh2(K$uguKMbXiZe2i+ud zYP&E>xvxTCkid2+=D5kRF$52FA{$_dwKbS#GL*2Njy2(3w>eDnOI;oH=|JrJ_nWiL zUR%?(@RUe}e41C@i(hO&PhXS%z84we_{J=~+4OX`S2N zcFHL12>g=z(14qDWsZ~0TAg8mcKclY#6 z%~#VB8cAu=NqZQuwzi(2#MX9wzM&%!>;5fj*|RxCq|A-6Na$zsxE*gaxi6N~CW;W_ zigsnzl~emZ^r?sfil4j5`4hWAo-ND8KkNJIED3?*vQ6;YcNxp@XG^D_Nzc@L6 z_Vc?QzQf*vl+ew$6SiH9baa|-SqnaG?wkGjzmyGm(et^gV-~3SBJ%{>?>i^lF+V{& zUXvqg-R&e+JUdV1vXGtY{lopXtZCJ2T#Nqo8p~Kj*Wy6t)0G06%qR8}Ej|Z*!^9;V zJ#E^q#6YQSL^3T+?x~GFQvYZJL|ywXit~|$zH#d2Oucgl5?|jW;3(sXy}KbF1kdMW z)=N3@^73HFHskor->KejDEm1;poU~K+EgXBuY*>m9Jf6imur9whWEc13^=qcwBfVWmUTMH_y0eX--`=cke}oo%)klS6m!M;)p%w9fbKwt_9|o+FdjGhHYET0DRnSb%<1pmU!~y$)vGYmU?f8sf&e$1*mGEc7FT4 zk38VGu@P@p2Gy>7Kto?oD-LlHC8?i~JY5L&DF+O{({eD_8AhC9<$;TfE2xMP(ME-U z@`zE$$A27PzZiN?Qc1TqKR?tGYd-lo?}MOaRN~)R_ffTx{ojxE>|&JRkXa;e*Gvt>nB99T`N08Wx!Ne zP3n9#f0@>;0WSoRVL_$f&ylXm6?yCSzWbzrNslKwQttPDKmUA_hy7za9ZhNKzm_Lk zkyO!8!gnD$juKfiWI2{;G9f9b{QTE|HSkN7<#7yp9i5%in3L&RxNSqR4tkknZSgfq z?=;$@y81yr!ev7{93q7%~Xe4lAyoZNFW8(kV-=kCdu97~7eI$f?Vr{hOKimh7(LbSv zCT*CPBAJfEdGfo0;$GV=OR?hnhB0vb#99MSBYwRyZ;1*EC#bSkpf1OKLL{Y?^{?kA zzuw$jopkm4pDsp3Q}b%kuQ71kHeeqt>2_;0f~yh3AW-Q>5h9^@lWOyBW3O3!&aVfT zV0-)>$}tJ<)1ioOa6uPYAd%9W2)kyPR7>SVRg|~J(aV9B^Yzk|oFK`TAK=(#-W}CB zRwNkQa$aUwHZh@xastgANSmszqW}qLNnekO;tM0Jvwhf?mVq$W*^U;f1JH(+(K9n|Z*KmWl4hrfjE#*2`u^gBz<<$qUTTQOMq`!$gktu9x-W>%{rm|b z3j3)3D0T@6jc1EAqg77a^ZvDQ6eX5#D$s*28@C%U>!VicbHsKuBdWC`(U$U?qM?VP zQ)OAI?AlV_TqP`pak8V?hPsOAS&wPV}6 zR$4U}-CBUCj%5-LUuu|U${hLmW$h?lBt%+LG`mEPlV6TH7{OELdt`?#5GQH zajbM+Da{9Is7COxqoZSa9gEEQW2{}jKkLRs`O8K(O95Kd><+tHK@wcF3obFy6cG=h z3=cJNMAuh;T|kKrA96LoUT-quW5n2Id>7z>5DJitj*sK>=zdL}9vc%D7RFP3!k(lI zc?;5uuXGEeBGO8!Sw+i$gR7R^#(o61w^|}kQixNgOz4=ta=@1MqAZ#JNp^N6*@@d z?MjIBmdIXTw>y<7sapqDSLI$G$Ha%nuiel|2!_g*{l3p-@;h||NfV3 znDr6Vm%p^~;nUl1UoZ*ZBZsq8P7*hsfW6VFr%1x~A%F8n(;rG==7**GNV+0|v?|9sy_^#bu1ip6ez0M996a{b;W_6Q7yt2BuKHw*>3#Y`2^jG`m#iUCgM9fa zaf2Oc;KL%s?vdcTtNLFdGvA__R{$^$^@V;}?KzJr;K)L?e#F(!%B%k!zup_Wp`u<9t^laIMb}a_Ghuyiy z{9~~e9tEkx>-k@~1pRoMQC79l zV*eOu%$?Kr>rLrKoVK)@)tb(>Hc6B=I@b?A$U^L}t}Dh6Dff3Ui&(2|%AqbJgFb#A z--ZGPnW9VVW$O|!y&dePpsc+06;G!~Z>pu>`A{0k5U6^+u75NNlhEqLIZ z^xFu-A>W>@eC%>H3JPk+EZy$?4r)!C1y?x{c*(%_o9*VEW8c;ir1I}noC#m2V zhNpo5s7SixSjnp%X0i3kvED|u1>aFgEa+NX5REOg4L55$`}*4vE&f0V zyYrFr+(;WInw?CRIqLvg_ZiIUpZ@T1s1hlJ00LxyZkgJ`d`m@}?Pog=k0)|WH`gcaE8i4+kFnMpG_1cf>?;zOb$}3;A=j<Oq_YPR5IPVxyxT*bR+$%C1u5&(7;=cgoEtGtn?F~)0$ zAfe8!N2wx<;pVmxY|0N6--m}2)Q(7h4|bp|Eh(|v{?%xA=eZUcvxKPUCgL;y8z z^_0E^!=^nBy!5UeX=-jBCyS@ye^qwFrw$T~v*oldev4{^`)oCpRf)hkE7VCr1lbq+jWP};P3e0~%loc|~2QtIYF%1%D4%goVUk2bs&_`UO; z<(Q{)J*&;)_7i1`i;E5gbWtc`R7*a+RoJkNPEF?L{^j$N_M7q>&+EOoAPe{K=H=9v zXmU%ARKDb21?(@f%U~JV-tl^+NBlu&(bwXJ^-fIwWFcl#g=(3CeUB+sXyCkh#>QEO znrzDJB>z;U&T-~&eryD#vPjb@u-VVw{+9TEPa`LlV2(4?q?CuXfQ>W*oQBY`c5Q8K zj{kn-^+nU(cLpJ@J^RX5f&?&+;7gX#pBNkaOqHU<27SFkCuBv4tO6MNzOJIFsYyPX zdaZ>&D(`y?!<}|W&+#WVFvl?F;7sjW>~T9zHb2>(jn8VDGzn^j5(2Z8ZF+m*$XCA% zk$W)V>*rUbnvQeN)IeXq$l{9s!jZUJz83*@RYlwRdTcCN`~1D%CLnkOnd5$`^GscN zVe-uO9}8 zhA$h7L&g2gDm;20rWM>Y`k(Fh^EIoc;Mw{MrdlrTiMrGgG>%G}64wqMq4#7+x<}O2 zkG(7+-FcmXH++~_BwgJ2GWvWLzKQ++3bdw)3enCC6vcGen`Hk)(5$U5|0}Dqk7@@>DtA5CoM0g6ptG zh=1WRaLqRhcceH})e0z|*}2K*NxiWZf#5xMo|90zoikJ)aB&QllIV!9Mkz=E9Z8VCML*{WL_3CJAzpgd(^Y#6j?NF6v z2*GQg2Xhh3dpg`-qRq|CFup_3KaWYu%ge!NrFS)*>~u9h4#Xh#@gm`7w9(y(s_a{y zV67Hi8rs|2D=Nq=IO}J&gw=4H?faZ?_PZVs;;<7fx=cBUgi7CmqMi{}q^q)bz<^O< zV94?Qeb-ivq+76uSV7+=p5}j#!p-Ua;QzmdYc^hLg|_GA^>c73w>4B+w#S6Qt_eO) z$jN*Vi`G{QK_7{1Ago2XxwqRwYTDaxl3qw^iV+{TH_vVx)L4yAPId*<%UAIrDoFKbH1> z`K)AJ9B*k;)Ph8UN4~bcUJAH>h$bhpV__%oq>U$-4k+p{T`1X<-1Zbf;_ z2b@G^H}vqoOx>g+Hmyda@|*B6Sn&9D!z0fZLhnI60GY>E<*`-(#2xd^389RM>OQ#q z)0>2f^K)^5T+7x*;Wup6%@k;cjB!!B+d0B8%$6@$e54ChhoZ7EEW0$@>{~D#3 zZw~BAujB?uaj33k9iza=;^=fKE?Ul3gJ%J`KNNJW%@$R-#&Wf)IMNBa!gV))peu&S z>vGdtD#=5@q}8{!?hazlMyISO+ZTRZYwX%hwaWshvIoXu??wf92!ha;bq)q#Tw&8+ ziFJ^4U)5;hC^ioOE_y9bK|!I;0n6$bL5PGz8a8{DfBsRRoFpbLE}vr39(V;vek3}E zP6!xE8^7?B7=>;vq6RQuS;#jmHsAWys9pC5EEy-)*$<(i0-AWPiH^`aC^wso>}PM- zjmCgd@Nj*iJT&hLC(TO?Iv>qJ`&s1^^N#-2;5Y;)d$RLveSu%2w}AUBgxtx<%p8q# zm}@ZzWvszob`tZyBa4zdIzBGEdFHckf#P2QfMM(4penV0wvuE2S+_f1zFHFGA&1Eu zK=%U94I0w9{0Nb!%ltv6Pj^l2_mEzu>T}`;V~m>?Xe)o)Tl%?Yq-@G9qMa;)%7ygIyjLNvZK49FD$N zDR5)WSMcztt*h^G{dK%GBcC^tFEQuV&zqMc0T2ZwTUUTug^dP3!M760`q6oDe&Z#& zNGJ$HqrPQJ_-N_L9M^OL8jnoXt7uv;Im9s-B*KSz1E`gMD4&N1L)6-(Y#yXb2AqTL zRqr@sHHFp9Rj)qYndkT2o}HaVLcxHhekLo>h*R1_EHb11}sk3&X((HPfl-E}tFP&BdR2z9Kz#7drkeu#F8z z>xcQBG^(RM?n)(N5iPvXj)y9#5*M2_Cv$!~VEw>ky{55wIGXFpM84U-|EW08aOLt7aHcH=Ly= zR1Z#R^=70%c@1C0d5(uF4_56UlDSDyK+tVxYm066au#{oY(13Sywk=&5tR=J3yZeI zO0^D$gO~5DfeC!zX%|Zr(dD{+JDh*_r|doDu+O?>ps#Z*_iL9TKw0*z`u~Sy>m8E3 zAfd<d^*Skhi(*6)yIRvm zMYD+GG#+_M0?5^YWrqpFic3nG7Lde;j|$3^&@r=+7zLo)qqq}OTb`P)2*S-e7hTR1 zK=xPrz? z0W#j?y7c`p)ERgl@JB|eiVg{OkVwDs6)#aJUW@iZyJ34^!1vQOfH-tX%a)NtE2Geo z($bB?wb5d!)>oBf_Z|q8R)8tu<>_8mS66W;AT$6<;SL#3fEvovCN)`GIztDPjtR6x ziK%&%Xjp5rq8ipqO64YXGY{N^%T5`+uXjE8^93yAS-E$e&P0w}N=@-t)uwZQsA-n(^J>C6z{v`=D-8 zcz>YFZ18JpYjv$BD*D)7XMR6uu?eUGy>a9;S|aB%FbE9dvv@ly0L&ndLfx|i&u!P9 zYf&D3#l80q4$s;nMXwXxAs~>`I|7R*c{3hA2ek{6h)H>#W{1NrggYX}cl5p~Cm7!hcj2m2X$KL#%ac*zj zZrT9yXm4*12EZ!=nO>Vyk2TX#DrxYTmjni!6X!=8@`?qcdG3MxNjdLg|MVF=3;Hnd z7i97WKr8iAa#mx-x4r))DDE3nx)IE2vs2tn2yq2rB%R}c)&R&Laf;wB?^6cDNg0y0 zAW?`G@9OH8R5Ibz_A7%~Y|4c!Ypbh0AO0MGlDp5uc{K-d*{YrN^zv#y98uAK<%4o) zTLJz6Y(_8?SV5(|5|jy*7U*>429sfsEL~h&+_`fnOWhh!p{#7^VtC5K|4~E!sjBL5FDhERY2 literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md index 000ea34..ed0b913 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,9 @@ -# Welcome to MkDocs +# OSR Console -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +OSR Console is an experimental turn-based dungeon crawler RPG in the old-school renaissance (OSR) style for your terminal. -## Commands +## Packages -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +- [osrlib](osrlib.md) - Turn-based RPG game engine library. +- [osrgame](osrgame.md) - Demo console application built with the [Textual](https://textual.textualize.io/) TUI framework. +- [tests](tests.md) - Pytest-based unit and integration tests for `osrlib`. diff --git a/docs/main.css b/docs/main.css new file mode 100644 index 0000000..806a7c2 --- /dev/null +++ b/docs/main.css @@ -0,0 +1,24 @@ +.md-content__inner a { + color: #d17d00; /* Change for normal state */ +} + +.md-content__inner a:hover { + color: #ffa600; /* Change for hover state */ +} + +.md-nav__link { + color: #d17d00; /* Change for normal state */ +} + +.md-nav__link:hover, .md-nav__link--active { + color: #ffa600; /* Change for hover and active states */ +} + +.md-nav__item--active > .md-nav__link--active { + color: #ffa600; /* Replace with your desired color */ +} + +.md-nav__item--active > .md-nav__link, +.md-nav__item--active .md-nav__link--active { + color: #ffa600; /* Replace with your desired color for active folder links */ +} \ No newline at end of file diff --git a/docs/osrgame.md b/docs/osrgame.md new file mode 100644 index 0000000..d0b875d --- /dev/null +++ b/docs/osrgame.md @@ -0,0 +1,3 @@ +# osrgame + +--8<-- "osrgame/README.md:2" diff --git a/docs/osrlib.md b/docs/osrlib.md new file mode 100644 index 0000000..0638abd --- /dev/null +++ b/docs/osrlib.md @@ -0,0 +1,3 @@ +# osrlib + +--8<-- "osrlib/README.md:2" diff --git a/docs/tests.md b/docs/tests.md new file mode 100644 index 0000000..10671bf --- /dev/null +++ b/docs/tests.md @@ -0,0 +1,3 @@ +# tests + +--8<-- "tests/README.md:2" diff --git a/mkdocs.yml b/mkdocs.yml index c97182f..0918a2a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1 +1,77 @@ -site_name: My Docs +site_name: OSR Console Documentation +site_author: Marsh Macy +site_description: Adventures in turn-based text +site_url: https://osrapps.github.io/osr-console +repo_name: osr-console +repo_url: https://github.com/osrapps/osr-console + +theme: + name: material + logo: assets/logo-osr-apps.png + favicon: assets/logo-osr-apps.png + icon: + repo: fontawesome/brands/github + + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: blue grey + accent: orange + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: blue grey + accent: orange + toggle: + icon: material/brightness-4 + name: Switch to light mode + + font: + text: Sora + #text: PT Sans Caption + #text: Actor + #text: Alef + #text: Palanquin + + code: Martian Mono + #code: JetBrains Mono + #code: BIZ UDPGothic + #code: Palanquin Dark + #code: Oxygen Mono + #code: IBM Plex Mono + + features: + - navigation.instant + - navigation.instant.progress + - navigation.tracking + - navigation.sections + - navigation.prune + - navigation.indexes + - navigation.top + - navigation.footer + - toc.follow + + - search.suggest + - search.highlight + - search.share + + - header.autohide + +markdown_extensions: + - attr_list + - md_in_html + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + +extra_css: + - 'main.css' diff --git a/osrlib/poetry.lock b/osrlib/poetry.lock index 64a742d..3fc5091 100644 --- a/osrlib/poetry.lock +++ b/osrlib/poetry.lock @@ -578,15 +578,30 @@ watchdog = ">=2.0" i18n = ["babel (>=2.9.0)"] min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-import (==1.0)", "importlib-metadata (==4.3)", "jinja2 (==2.11.1)", "markdown (==3.2.1)", "markupsafe (==2.0.1)", "mergedeep (==1.3.4)", "packaging (==20.5)", "pathspec (==0.11.1)", "platformdirs (==2.2.0)", "pyyaml (==5.1)", "pyyaml-env-tag (==0.1)", "typing-extensions (==3.10)", "watchdog (==2.0)"] +[[package]] +name = "mkdocs-autorefs" +version = "0.5.0" +description = "Automatically link across pages in MkDocs." +optional = false +python-versions = ">=3.8" +files = [ + {file = "mkdocs_autorefs-0.5.0-py3-none-any.whl", hash = "sha256:7930fcb8ac1249f10e683967aeaddc0af49d90702af111a5e390e8b20b3d97ff"}, + {file = "mkdocs_autorefs-0.5.0.tar.gz", hash = "sha256:9a5054a94c08d28855cfab967ada10ed5be76e2bfad642302a610b252c3274c0"}, +] + +[package.dependencies] +Markdown = ">=3.3" +mkdocs = ">=1.1" + [[package]] name = "mkdocs-material" -version = "9.5.4" +version = "9.5.5" description = "Documentation that simply works" optional = false python-versions = ">=3.8" files = [ - {file = "mkdocs_material-9.5.4-py3-none-any.whl", hash = "sha256:efd7cc8ae03296d728da9bd38f4db8b07ab61f9738a0cbd0dfaf2a15a50e7343"}, - {file = "mkdocs_material-9.5.4.tar.gz", hash = "sha256:3d196ee67fad16b2df1a458d650a8ac1890294eaae368d26cee71bc24ad41c40"}, + {file = "mkdocs_material-9.5.5-py3-none-any.whl", hash = "sha256:ac50b2431a79a3b160fdefbba37c9132485f1a69166aba115ad49fafdbbbc5df"}, + {file = "mkdocs_material-9.5.5.tar.gz", hash = "sha256:4480d9580faf42fed0123d0465502bfc1c0c239ecc9c4d66159cf0459ea1b4ae"}, ] [package.dependencies] @@ -604,7 +619,7 @@ requests = ">=2.26,<3.0" [package.extras] git = ["mkdocs-git-committers-plugin-2 (>=1.1,<2.0)", "mkdocs-git-revision-date-localized-plugin (>=1.2,<2.0)"] -imaging = ["cairosvg (>=2.6,<3.0)", "pillow (>=9.4,<10.0)"] +imaging = ["cairosvg (>=2.6,<3.0)", "pillow (>=10.2,<11.0)"] recommended = ["mkdocs-minify-plugin (>=0.7,<1.0)", "mkdocs-redirects (>=1.2,<2.0)", "mkdocs-rss-plugin (>=1.6,<2.0)"] [[package]] @@ -618,6 +633,32 @@ files = [ {file = "mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443"}, ] +[[package]] +name = "mkdocstrings" +version = "0.24.0" +description = "Automatic documentation from sources, for MkDocs." +optional = false +python-versions = ">=3.8" +files = [ + {file = "mkdocstrings-0.24.0-py3-none-any.whl", hash = "sha256:f4908560c10f587326d8f5165d1908817b2e280bbf707607f601c996366a2264"}, + {file = "mkdocstrings-0.24.0.tar.gz", hash = "sha256:222b1165be41257b494a9d29b14135d2b7ca43f38161d5b10caae03b87bd4f7e"}, +] + +[package.dependencies] +click = ">=7.0" +Jinja2 = ">=2.11.1" +Markdown = ">=3.3" +MarkupSafe = ">=1.1" +mkdocs = ">=1.4" +mkdocs-autorefs = ">=0.3.1" +platformdirs = ">=2.2.0" +pymdown-extensions = ">=6.3" + +[package.extras] +crystal = ["mkdocstrings-crystal (>=0.3.4)"] +python = ["mkdocstrings-python (>=0.5.2)"] +python-legacy = ["mkdocstrings-python-legacy (>=0.2.1)"] + [[package]] name = "mypy-extensions" version = "1.0.0" @@ -1349,4 +1390,4 @@ watchmedo = ["PyYAML (>=3.10)"] [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "95c4d13b0e6ea97b70a933d525d27b0384a2f4d1d33b06bbbd87ffaa3504e67b" +content-hash = "c6573d89b64b1d8a939b2f84df12e9b497d832c3cfc0373c4c50bbc040788d86" diff --git a/osrlib/pyproject.toml b/osrlib/pyproject.toml index 1435d8e..0f923ab 100644 --- a/osrlib/pyproject.toml +++ b/osrlib/pyproject.toml @@ -16,6 +16,7 @@ black = "^23.9.1" flake8 = "^6.1.0" flake8-docstrings = "^1.7.0" mkdocs-material = "^9.4.6" +mkdocstrings = "^0.24.0" pytest = "^7.4.2" pytest-cov = "^4.1.0" pytest-mock = "^3.12.0"