From de3ccc9892c9788518e18abdf23dfad17b0d8c79 Mon Sep 17 00:00:00 2001 From: SubhadityaMukherjee Date: Thu, 19 Jun 2025 19:06:07 +0200 Subject: [PATCH 1/2] contribution --- CONTRIBUTING.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b8cdeaa7..35ab30b4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -191,22 +191,16 @@ Make sure to do this at least once before your first commit to check your setup ## Contributing to the Documentation -We are glad to accept any sort of documentation: function docstrings, -reStructuredText documents, tutorials, etc. -reStructuredText documents live in the source code repository under the -doc/ directory. - -You can edit the documentation using any text editor and then generate -the HTML output by typing ``make html`` from the doc/ directory. -The resulting HTML files will be placed in ``build/html/`` and are viewable in -a web browser. See the ``README`` file in the ``doc/`` directory for more -information. - -For building the documentation, you will need to install a few additional dependencies: +We welcome all forms of documentation contributions — whether it's Markdown docstrings, tutorials, guides, or general improvements. + +Our documentation is written either in Markdown or as a jupyter notebook and lives in the docs/ and examples/ directories of the source code repository. + +To preview the documentation locally, you will need to install a few additional dependencies: ```bash uv pip install -e .[examples,docs] ``` When dependencies are installed, run ```bash -sphinx-build -b html doc YOUR_PREFERRED_OUTPUT_DIRECTORY +mkdocs serve ``` +This will open a preview of the website. \ No newline at end of file From 59f1f8829d0b34cb694a9c16c18dd3889db09ffe Mon Sep 17 00:00:00 2001 From: SubhadityaMukherjee Date: Thu, 19 Jun 2025 19:15:57 +0200 Subject: [PATCH 2/2] icons and github repo --- docs/images/openml_icon.png | Bin 0 -> 3267 bytes mkdocs.yml | 5 +++++ 2 files changed, 5 insertions(+) create mode 100644 docs/images/openml_icon.png diff --git a/docs/images/openml_icon.png b/docs/images/openml_icon.png new file mode 100644 index 0000000000000000000000000000000000000000..4808572ff1f1767341adbb73a8a1d181220e2fb8 GIT binary patch literal 3267 zcmV;!3_SCRP)`j~n;b|%hiEJc-L$&w{m z50F$Ol7b)-BtX1DE`cSmSnTWeMED;Cw%KcJG|C-#Op+-Fpdcb3`y4FbP^7 zTW`e*g@UcBD*F5TB}tN8x~^-9L_$rc(;s?$(f|S@00!UemA3yZNXDbls4B}c1VMml znlMfCme!}s1ynvp`M$os_dPc$E>r}X8DAj|34#y^1On8yZD^Wy%isZkTMqCnf+w9K z`{}B%a40Shlx0~q4Z{Ec#O_@4&Z$*R=QW;~jIm^?RH`g2EU@MJar|;DQmfNwMRP>H z|8CEK(-F|hN<(|j zD*c^H)(aX>{^{9muIFW0t`v(!o8vfSGMQ!f*s^#am&=*8S}m?=+PPrGS`WadbL3$` z5H_~7w781J;%xzcOA=xcgwyj5dB>Bh)o3(|R4Szd(BsXUU*HKfkM}rDLP#4Sgy(r4 zx~~7~5MUAX0hnm<+DC)I;3F=VYkqWe)C7RPU2SE2KF>EPrD0~<^SZ99w+sA-mQYor zs?CTzo$*LK&u?_Q-L9YDD!wwzai20{<`H$im?;Iy*ZtJw0s!sK(=Q?Ln)hZgFJ8&x7K{Xh28- zn9($CX>oD!wiEbZ6YpkW!VKTQnc>MopDaHy{Uz`H?a z(tZr@s81oY$E{vWBoeBkD7ZccH6lK+3T@f4MR2>_D+wWjrfIXLY3gpbyNeLgX4`h^ z#bf1t9K&M(%(0;G(7*L^M`vbcDz`GX0sT94BY9S-VjLZYm+4&j-u0aQ^&x^B12blS#8sC;$K!rA;qL z76Qd4&OW+I$^dZjJdZ{Oxk>f;4#4gXFMj{N@Z7hPr}m$bD8cKDAvBTj?%MV8x(kU! zLhtJ865MWgKc#elF;=lGE0W9Qa+fb(Zde9xQia$cfW8(zdbi8v3YaF@24E*47-XPN zH8nM@4242`E|=4*)oRQzjKjLFzq7cwSZE~pn@Xrte&Z3J75`kIdO~M}NYP}|=p9{Z zL^rtJADrw~2q9rn6q9cx+V&!0e9@%F(Qge&e?7134F!Kw32oZ6iT8Ls0YZq&FpOM2 zpI5`-aEMa6l@Q{xZ9DSxi4yzes|QKU^)mHa9mnKRrGD(PkhLiI{_fgE@}l zFh4(U&&|!Dxw$#l)YNp85W?5%bw#jP5Fqw-8K#=~J9wTC`Fy?-0P~|Gu$#F7HZ;3< zA`-gvm_9c*2LL$t%6Yz8Bf{V#Jq1Nk?8n!3BwtK4eT8S(b-CR!e_@3<2gVvMq4)QJ z;lFwvATPn;39d7LdZxL#xt2SaUjg8v;K1K}d1qC8dt$?gEX(yveg4?FZr8b~R>u^8 zs9_jWb8~ZQqsEB;Hv@#(DkBtL{mM#?;|APr_Zh~pl@Nrlx#mlPApB=26pEzNX(bp8 zUii~1W@S~`egKSlpBfGw5k=8#ln>rV;A5$0_SjO#+o8%4F8~_=arET!D1%T>V*u%uxa+S1YzY@nB30}lW;CHFZTjuWk|t)sD6 zOfME>34qox0v9e^u>1S_3$sJ7SGvc3Pg7OZ&StZ4xi)0nZuenAEaC4Tk92kTYr!3R z*Ux67_Ee}&a|8$iK&;hK0uT^Iktc-cw-fvg6AwprhgbaJkmNsGuPKVc^7rQ+HN}o& za`#v6>Jugo2Rx{cjEoq9AXLu25_!7AU;k&9WIwTEb2azOT+bzrki)9LIZk#>FDVA9jDV-7y-Kj#GVq&6kqr~>@ z+g*|*tpZ@Hsv5T}%l3FY{gl#v#+Ymv#%L@Sle5_@?!5C(_v81^{lVCD>*}$omi%Wn zW|Dg!n*2+Svc9@OU%hwV_OIoOCFRnkOLoH=86m`QI2^L3X$$FeTCde=mLy4wgpg#q z>9=yD-3Ojp>U-)T@45#kefb}jF3tv~bBnHN##r>_U8BD*3D!LTD9^E>nl8@F6oRvc zVW>+>OO5FR$z&4AWYQdt?EZYPY((l`J)e8;z4vqgI(8p@3?R<}fGz}AdOV&d%H?v3 z<2c!}EVv|7zA=OYNEAG4D5U|P&nKtTX}cjFxK@dF0{Afzxi3r(!uyGpP}9$5RFD{r_-79cswQ3G|k#y z^kSpC-@EkayOnf0Ew{I~M<}IqX=zDkaP<7o5_T`8bjY%-qw#oLw$@0$(A^0yu*w!e z5T;iD=s_2Ng8*FM2&~^|X$zdM>>C&u$lVHw|20aCjg6TAD#Pb@3zT3Cz{-~Aw){4K zVD`+^)RdOb=l}b_YeVKA4M*!v0HH4B$7cv3-fL^wqMqGvINI-GgbTJ;PharXW10={ z;7AC7>jpKGZKRYAT-yMt%eo`8RfDHZjxYe1W3GOWC`p-6C^VJN=WPI3ck%O+e!u@d z#z|W_rVEU*s9_jNB9Xx6i3diV{;qpKxovE#^@-}Qw{|$*npezkU!E2I{9|u2f!<3D zrc1}mD0l-O+0YJsy?d_}7Ppy0o;KfGm6MKBr8gb2 zb=7r99^;esD~z#=s;Xww>9n=11nTuVR%E22ls4mxu{pyqlKM;Qnh8&j0O%q%8EQIR zIi{*=y7uzgAZu})0ws@U04XI{^k;xKPOf=o3Xz0!1GH zF8~k=pX7OdQy>sz;VWcui2nkS1`FK1o=kxhku~>$;jqBtE)}?xCR}-tYJO0Jtp6DrGX63Z)dCot*)W<2DgOT5Q{% zR8@6+c6L@8&KoBE!f9=KdCy0EZd=W;m!!20#;sn6$g zQ%VI*(<+%vMoT0T@caGf?(U|95M;C28}Bb?{1=b&SS7vT;uQb@002ovPDHLkV1h=H BM-~78 literal 0 HcmV?d00001 diff --git a/mkdocs.yml b/mkdocs.yml index de3ca15e7..38d9fe05a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,9 @@ site_name: openml-python +repo_url: https://github.com/openml/openml-python +repo_name: openml/openml-python theme: + logo: images/openml_icon.png + favicon: images/openml_icon.png name: material features: - content.code.annotate @@ -11,6 +15,7 @@ theme: - navigation.tabs - navigation.tabs.sticky - header.autohide + - header.social - search.suggest - search.highlight - search.share