From c099b8a98dc943a941629b3e06d99bcdcda8a71f Mon Sep 17 00:00:00 2001 From: Jairo Velasquez Date: Thu, 31 Jul 2025 13:11:52 +0000 Subject: [PATCH 1/3] Trying not to lose changes --- .codio | 2 +- source/conf.py | 14 +++++--------- student-source/conf.py | 14 +++++--------- 3 files changed, 11 insertions(+), 19 deletions(-) diff --git a/.codio b/.codio index 54542513..bf1af96f 100644 --- a/.codio +++ b/.codio @@ -2,7 +2,7 @@ // This file is used to configure the three buttons along Codio's top menu. // Run button configuration "commands": { - "Make": "make html", + "Make": "clear && make html", "Start Ungit":"ungit --port=4000 --ungitBindIp 0.0.0.0" }, // Preview button configuration diff --git a/source/conf.py b/source/conf.py index e2fdd742..56071e1c 100644 --- a/source/conf.py +++ b/source/conf.py @@ -88,7 +88,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'pydata_sphinx_theme' +html_theme = "sphinxawesome_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -96,12 +96,6 @@ # html_theme_options = { "show_prev_next": True, - "footer_items": ["copyright"], - "navbar_end": ["navbar-icon-links", "search-field"], - "navbar_align": "none", - "search_bar_text": "Search ...", - "show_toc_level": 2, - "page_sidebar_items": [], # "external_links": [ # {"name": "Overview", "url": "/instructors/getstarted"}, # {"name": "Authoring", "url": "/instructors/authoring"}, @@ -127,7 +121,7 @@ # html_sidebars = { "index": [], - "**": ['sidebar-nav-bs.html'], + # "**": ['sidebar-nav-bs.html'], } @@ -211,7 +205,9 @@ # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), +} # -- Options for todo extension ---------------------------------------------- diff --git a/student-source/conf.py b/student-source/conf.py index 397d0572..e5efb422 100644 --- a/student-source/conf.py +++ b/student-source/conf.py @@ -88,7 +88,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'pydata_sphinx_theme' +html_theme = "sphinxawesome_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -96,12 +96,6 @@ # html_theme_options = { "show_prev_next": True, - "footer_items": ["copyright"], - "navbar_end": ["navbar-icon-links", "search-field"], - "navbar_align": "none", - "search_bar_text": "Search ...", - "show_toc_level": 2, - "page_sidebar_items": [], # "external_links": [ # {"name": "Overview", "url": "/instructors/getstarted"}, # {"name": "Authoring", "url": "/instructors/authoring"}, @@ -128,7 +122,7 @@ html_sidebars = { "index": [], "student": [], - "**": ['sidebar-nav-bs.html'], + # "**": ['sidebar-nav-bs.html'], } @@ -212,7 +206,9 @@ # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), +} # -- Options for todo extension ---------------------------------------------- From 945ac80cbb92863dc3bf9ab05032ff6db7a0f94c Mon Sep 17 00:00:00 2001 From: Jairo Velasquez Date: Mon, 6 Oct 2025 12:15:58 +0000 Subject: [PATCH 2/3] Testing build --- README.md | 8 +- source/_static/css/codio.css | 20 ++- source/_static/css/custom_body.css | 139 +++++++++++++-- source/_static/css/custom_index.css | 14 +- source/_static/favicon.ico | Bin 4220 -> 2556 bytes source/_static/js/algolia.js | 24 +-- source/_static/logo-dark.svg | 7 + source/_templates/index.html | 187 ++++++++++---------- source/_templates/layout.html | 21 +++ source/admin.rst | 2 +- source/authoring.rst | 2 +- source/common.rst | 2 +- source/common/develop/projects/projects.rst | 1 + source/conf.py | 64 +++++-- source/getstarted.rst | 4 +- source/index.rst | 4 +- source/setupcourses.rst | 2 +- source/teaching.rst | 2 +- student-source/accessing-codio.rst | 2 +- student-source/courses.rst | 2 +- student-source/develop.rst | 2 +- student-source/student.rst | 4 +- 22 files changed, 360 insertions(+), 153 deletions(-) create mode 100644 source/_static/logo-dark.svg diff --git a/README.md b/README.md index a2910b89..c0f10843 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,7 @@ If using Codio, put on the certified Python stack `Python Ubuntu 22.04 (pyenv)`. ### Install ``` -pip install sphinx==4.2.0 sphinx-sitemap sphinx_code_tabs recommonmark git+https://github.com/codio/pydata-sphinx-theme.git@master -``` - -Due to some versions being outdated, temporarily you will need to use this command to install dependencies: - -``` -pip install sphinxcontrib-applehelp==1.0.4 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-htmlhelp==2.0.1 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5 sphinx==4.2.0 sphinx-sitemap sphinx_code_tabs recommonmark git+https://github.com/codio/pydata-sphinx-theme.git@master +pip install sphinx==8.2.0 sphinxawesome-theme=5.3.2 sphinx-sitemap sphinx_code_tabs recommonmark ``` ### Build diff --git a/source/_static/css/codio.css b/source/_static/css/codio.css index d58bf2a5..200d25cd 100644 --- a/source/_static/css/codio.css +++ b/source/_static/css/codio.css @@ -234,4 +234,22 @@ .float-right { float: right; width: 300px; margin-left: 50px; - } \ No newline at end of file + } + +header img[src$="logo-white.svg"], +header img[src$="logo-dark.svg"] { + height: 32px !important; + width: auto !important; +} + +/* header .brand .site-name, */ +header span.font-bold { + display: none !important; +} + +@media (prefers-color-scheme: dark) { + html { background: #0b0d17; } +} +@media (prefers-color-scheme: light) { + html { background: #ffffff; } +} diff --git a/source/_static/css/custom_body.css b/source/_static/css/custom_body.css index 5e9114f1..ae5fae8c 100644 --- a/source/_static/css/custom_body.css +++ b/source/_static/css/custom_body.css @@ -1,19 +1,138 @@ -body { - background-color: #02064e; +/* ========================================= + Codio Docs — Home (index) only + Pure theme background, centered layout + ========================================= */ + +/* Hide sidebars on the homepage and center content */ +.index-page .bd-sidebar-primary, +.index-page .bd-sidebar-secondary { display: none !important; } + +.index-page .bd-content, +.index-page .bd-article-container { + max-width: 100%; + margin-inline: auto !important; + padding-inline: 1rem; } -.footer { - border-top: none; +/* Make every wrapper transparent so there is NO boxed panel */ +.index-page, +.index-page .bd-main, +.index-page .bd-content, +.index-page .bd-article-container, +.index-page .bd-article { + background: transparent !important; } -.container-xl .row { - justify-content: center; +/* ------- Theme tokens (only for the homepage components) ------- */ +html[data-theme="dark"] .index-page, +[data-theme="dark"] .index-page { + --text: #e6eaf2; + --muted: #9aa3b2; + --border: rgba(255,255,255,0.14); + --surface-hover: rgba(255,255,255,0.06); + --brand: #6ee7ff; + --brand-strong: #3dd8ff; + --ring: #9feaff; + --shadow: 0 10px 26px rgba(3,8,48,0.35); } -.container-xl .no-sidebar { - display: none !important; +html[data-theme="light"] .index-page, +[data-theme="light"] .index-page { + --text: #0b1020; + --muted: #475569; + --border: rgba(0,0,0,0.12); + --surface-hover: rgba(2,132,199,0.05); + --brand: #0ea5e9; + --brand-strong: #0284c7; + --ring: #38bdf8; + --shadow: 0 10px 24px rgba(2,132,199,0.08); +} + +/* Fallback to OS pref if the site doesn't set data-theme */ +@media (prefers-color-scheme: light) { + html:not([data-theme="dark"]) .index-page { + --text: #0b1020; + --muted: #475569; + --border: rgba(0,0,0,0.12); + --surface-hover: rgba(2,132,199,0.05); + --brand: #0ea5e9; + --brand-strong: #0284c7; + --ring: #38bdf8; + --shadow: 0 10px 24px rgba(2,132,199,0.08); + } +} + +/* ------- Hero ------- */ +.home-hero { padding: 5rem 1rem 1.5rem; text-align: center; } +.home-title { color: var(--text); font-size: clamp(2rem, 2.8vw + 1rem, 3rem); margin: 0 0 .6rem; } +.home-subtitle { color: var(--muted); margin: 0 auto 1.8rem; max-width: 62ch; } + +/* (Search form is commented out in your HTML, but styles left here in case you re-enable) */ +.home-search { + display: inline-flex; gap: .5rem; align-items: center; + background: transparent; /* no panel */ + border: 1px solid var(--border); + border-radius: 999px; padding: .5rem; + box-shadow: none; +} +.home-search input[type="search"] { + min-width: clamp(260px, 42vw, 560px); + background: transparent; border: none; color: var(--text); + outline: none; padding: .75rem 1rem; font-size: 1rem; +} +.home-search input::placeholder { color: var(--muted); } +.search-btn { + display: inline-flex; align-items: center; gap: .5rem; + border: 1px solid transparent; + background: linear-gradient(180deg, var(--brand), var(--brand-strong)); + color: #001; font-weight: 700; padding: .7rem 1rem; + border-radius: 999px; cursor: pointer; + box-shadow: 0 10px 24px rgba(0, 190, 255, .18); } +.search-btn:focus-visible { outline: 3px solid var(--ring); outline-offset: 2px; } +.search-btn .icon { width: 20px; height: 20px; } + +/* ------- Sections ------- */ +.home-main { padding: .5rem 0 3rem; } +.home-container { max-width: 1100px; margin-inline: auto; padding-inline: 1rem; } +.section { margin-top: 1.25rem; } +.section-title { color: var(--muted); font-weight: 600; letter-spacing: .2px; margin: 0 0 1rem; } + +/* ------- Cards: transparent by default (no fill), subtle outline ------- */ +.card-grid { + --min: 260px; + display: grid; grid-template-columns: repeat(auto-fit, minmax(var(--min), 1fr)); + gap: 1rem; align-items: stretch; +} +.card { + display: grid; grid-template-rows: auto auto 1fr auto; gap: .5rem; + padding: 1rem; border-radius: 16px; text-decoration: none; color: var(--text); + background: transparent; /* <- no box */ + border: 1px solid var(--border); + box-shadow: none; + transition: transform .2s ease, background-color .15s ease, border-color .15s ease; +} +.card:hover { transform: translateY(-2px); background: var(--surface-hover); border-color: var(--brand); } +.card:focus-visible { outline: 3px solid var(--ring); outline-offset: 2px; } + +.card-icon { + width: 36px; height: 36px; display: grid; place-items: center; + border-radius: 12px; + background: linear-gradient(180deg, var(--brand), var(--brand-strong)); + box-shadow: 0 8px 18px rgba(0, 190, 255, .2); +} +.card-icon svg { width: 22px; height: 22px; fill: #001; } + +.card-title { font-size: 1.05rem; margin: .25rem 0; } +.card-desc { margin: 0; color: var(--muted); } +.card-cta { margin-top: .5rem; font-weight: 700; color: var(--brand); display: inline-flex; gap: .35rem; } +.card-cta::after { content: "›"; font-size: 1.2em; transform: translateY(-1px); } + +/* Reduced motion */ +@media (prefers-reduced-motion: reduce) { .card, .search-btn { transition: none; } } -.container-xl .d-none { - display: none !important; +/* Small screens */ +@media (max-width: 480px) { + .home-search { width: 100%; } + .home-search input[type="search"] { min-width: 0; width: 100%; } } diff --git a/source/_static/css/custom_index.css b/source/_static/css/custom_index.css index f010d044..729bfd77 100644 --- a/source/_static/css/custom_index.css +++ b/source/_static/css/custom_index.css @@ -1,6 +1,12 @@ +/* Slight width nudge only (kept minimal) */ +.index-page .home-container { max-width: 100%; } + +/* Ensure any Bootstrap-like main column stays centered on the homepage */ @media (min-width: 1200px) { - .col-xl-8 { - flex: 0 0 91.66667% !important; - max-width: 91.66667% !important; - } + .index-page .col-xl-8 { + flex: 0 0 91.66667% !important; + max-width: 91.66667% !important; + margin-left: auto !important; + margin-right: auto !important; + } } diff --git a/source/_static/favicon.ico b/source/_static/favicon.ico index 8d393ea6d4c6b5bbb2aa1b6455726c3a2cbc32de..fae4ef6857a2e5bbf5aabf88f2722984997c4add 100644 GIT binary patch literal 2556 zcmV<|BMM6+kP&iEJ2><{ukHKRQccQ3mB*#}?yZqr^KM;!BwvFiC z`_I~M8v|+EWC~vYX3wB)8$mt>2kDu-p7}$_5R7bqqAa9T z0X=7jK2-|o`PP|Rg>`b|RDs<)ajMYn9oQ?ldvIRi{d-`i3h*7&sY1L5bgCfl!8|I= z7a;#D&~HIB4r$LbfZ!DB=ik!XE7X{ma|1gWkpP!*o0Swc52{@k4 zNx&jZ^G8K+HO(s-sHbRD2*advDOgW>DFyX}M#a#MtK?uk&d5PMCa55Wk(DIuM!X~( zjr5Y>NCp+fKn}7nkgY6SkzZxOlP_h#kt&Q~DGm0EH0&yAxH^=EqyMDA8)>LtN<-(Q z!O4Tp{Xh5r-2eaT`{+-9rX@4;li(`+DIUtiJ|OS(lHRP+C7& z)^I7`U7FBbFKd9ToeJ&sTMmi!GD`>!3x`4JW(h|%0exXJ$;eRGYQHg;aA$X8Dcp(EfiG>>xxJf*` zohZOfV&X9QkDJ8B&3oJ=Hg29PP2%IlZ-d0h&S$;E$#48sC06dfx|3+x*iYQzg$$FI zn#9bDk9vulxBkfzIbUPnaEl$HzIiF}^X!)_?zi{){5`Y%S>Auj-Te?4m3_j^vDRIZIayfzs4oB}}ou!)mb#aw)#pR7K3Brc}W9OXC3H~3(4;i{Os57d(*evbrx z{lc8y6Y&~;8@#le6?VBm~F5s8>*b>CM#kM))$8CUg`EOUOx%wD?@jn zTbyf zL|f50z?tx~MzbS23T7}59%$B~Gl04G!Iv~Upi{wgK6n`i1niv;m}ZI%!&!Y`G;7{s zFVq;Y!!a+m7%{BICVl!iFSujh9h^lu@LHl@)`4Q~Y{Z9--fx@W{j zShC@AEre&p>@`@@VX_F}Plow5FzN6(3guVSCTP-Ou?yvs;eHQIIvkEd`i$HNPC5*Z zLi%LbD>%8hSB3VUqc_5n#%`5OXrCB8Q+U$uT-uuu|GD8mIv{d!XPJfgi9KNIg0$5Q zRw4g$^Wo@($j0zWC-hIn3wG~@NXNjISpqPdANe&$q;(9ZbWK7qJ@w_aDme zDY^FN=Rx&wI2>-Z%@Up`^XpGIgl%Ha*vHW$n{THfa$K2zAH5belKJ@Sn332^Hb#s) z^Rz~b=jQ7vMT#r)_oEag-ZG!>H9{ozn*9_X5}W5=#D>J?{TFc|u@Ue^Oh{}bd=U>4 z8xg;+ksz^=aZgcTVIw4`2%yDC$wTm6896@=yf2KPL&&AwNct!Rn-(MLbPBY=2%A%Y zrQJx&r{KCOM%|o(YWc|s{OA-;buc3Hn}KvHM(3OYNJpb}PJyGN(L1Mr(a~t0Q=sT* zbRSRQQ6Jc7&p8E!=3)Ujo>Cy_L$P2S`+tR?qX?p_$&?I>13fJBUxz3N)}GYds!IBAPa${lZ1{W4<+Hl$Vw7+BcCN9jL^tI z&9SW<^y6YVu;XZ?pyR|=3i?Sw3hX2r8K^nsP6jTf2~Q=!aq3nA{B%JA>~xIq=Q-nm zzjziJ^m)!apwG@mgFVj#E%s~@JVc&nqMsMIb2b@PxZ5ykgF45=?E-W*IaZiEW|{_Z zj;Y!O-k#ZXc#gN8X&<8Ph^c?>u;#v{N4r3pv&`ZWX-j5vgR`DlZBe#nc3X_CndL)- zt(ooj_==eI7F{c5zs1&?d2ErjW1S^BX%vb(VSle2AyjmN`FPVCh-U z{9A`4V_AqTjH;eRX&r`)Wr1!SeyX0uY9sWlwk+H@LXL@9$TmWa8CckHgcv`t(BsHq zrE0e<{*A$j`Lbm>#^)~)V%jas)K&%?rnM~J?Jnvu;f{7&miBfie{37hTPn7f;|H0R@=XbQob^%jut3@4k&wE{_`80-?20tiBMwnBkNO~=`GMSEjrhA=ZTGcz+YGk46)%*@Qp z%*@Qp%$f7fJ7>nq9#Ul;qrXj;9avcfb#4O-i1dc5qjU@#;8aeV^6$KlBc+};${w&x zmpaY@(nbHLw8tBG+P}0*yK?ItcpD>k)|6qWQYJe{9npV>lB~9k9;hJMPF!hUK)3#X zMcRV9ySux)ySux)ySux)JM8rMYTEGwr$7B`p;03WLCQ;9WMu*`vP6bi2)SA00O|xCp)%-+0>4$ zMtB4mfCt1GKr)hNW;Xb0On8x|Mr`CG0#u*}QP2U_zzMhl*Wk%mUIH$`F<6}d5ugQ> z=&Lj@Fxb!mQjh?n>wq@^D#GA(ofobIlF+k*QTgEu0di1z0{k&x@DF~#H~975cgC{! zzUf`Zfc+Cw-$h=vNgm*U7})GcIv2ig3`RzC0^fk^^wWUTk09EkG z&Lu^v8gS&~)CT1RTUB5NXJmp`c?X(4@YV{6sxKrK)RSGh~r2QR2_<4AGDImX>w$dpgCB+NCm@e zd_=_&-*BTqiksan{a;>|CBRrPS(Jjlh*Bhu9Kucvq!->1Ez{f}=Kh1~9;TWJctP zcmB{JX?#mWg_c{AhNB)!Cp9@9o0MpEf;}m9;zaTh7%WP@0W*mQuJ$}OQd2{)u1O5g zN7G9^@H~2(Bm#s#C8s4DB+<+-?4+iSzs#&=3l+7+if5U#(U+0`rIG*TQT}8&X4yzI zS#{Vf6AoDx;oK;HN{ZkN!$@6NCmyPF(f_c+HE-EjCGp@~6eSAL;b_0=2W8Go%G~4BFigz==wQ3X2bps(92o6TpK|73k>F*8* z-Y9|xN7f7OWKyTOVdO-5T>E;!+7#`wGRUi}ka*0C+xt z6bwu%07fk+t?3h7hXr@CLC`32QuVDXfz+Er0*VCQR0=emqk^~)(#1FO7wVq2niI2j zN}wz%Ox{2W8!xkgr9Oc34mO9Z^md@vVSzyo1d?cELkqMN^_(1ISnDa%!{*o9N zD|mzK-f)rjW%Cl+Vzofc44pC5#r*A-n<-JqWKha}iHRx5yN01_S_V;yV|=UU81Ll* zV8uu2*2E+*78Jm(;$(wf8*eC`oV0&F&oQ%+`VGwQNpW%;fs=cs=k;NYxNzl|4e3^t zB-UZlf>9=Ti3bi_Xgk9j${%crRGlUwHvmrGbl$1PpXRd<&IA$zFtlEfY{i92U|74g z6j-`U^*-9S+odqwsy^7dKHM`iKgoHzM*1CS2MQTbA^!s1b4LIUE|;8q14G}BN{VFr z(OVaaw#M28h!Y?3OKJ+veMeIFktw&w1kKddqG6*9rHwn5aXvZtp2cldFT@}i?5?@LFwVa z&CF*}=^Mf4vyCpfnazCj`9SpjE6pIQE=I`I8XG{L*&KPb-==Ye>mEA+TR!g^@&9$v;#T z-;=j_Daiugq4l>VFCW_6SCX0k%1Omwv|f3xikPJx(eRO0gcwj^Ho?sTG~JbtsXRCt z5&lIf_AaeBkg9!z*w+{gC7Gxj>q|S=cu$1-;(`3tr!@>C597VPQ*%oU+vbn*X00A( zGNZM8Eex*cRIvv2d^KW2ki*J!afb8lrDIozrStNEv9<90(q)_v{XE0Nrv~B=i3ajd z$-|@nDDnzcYMww|@lcCqRjfsefWavb%l87dtq$vAS;v(dL}2oJ$J_G@ap~3KK;{Ng z!1iAE06x=sgsChz=_}{cdJN8LTdd}9>#*K6Uo}Z%uerA>IE>r^N4s>%N6x#t}9 zS2@*wP6)P0cJ*l;LwT4ShNwJVyMpMOn_V=k>qD~|bY|jb>pBUj7#7fk^E)|Ywv&Wc zgt*#F&5vP|0^mK2&mP$sX7aE&Qorgpf;fo^Db8{hldD&ve$b6#JK|-=qB~ z@-{23KCi08IO<2QM1>4jnXCG-h}hqx)4|j$B0My_sS_l$sr>x3Je1sxDf^U_=k;R-dW&1$$=ZwfhcA?8=lQYt*X2 zM!jxd3WtWb@P)BHHHl3&VU~Q-d8A7g-zYR=tVEN&(z8C;CPw~O9)@mGyo1 zcGNu59nE|m7XWkb$ev-nj`6K}Ke;LI+*|k%z~}D2LI+e|Yuu0rE3Gu*^wU|i_0!K-{WRaFpKf0sc0!;4 zgnN8?odisA?|L1dzUbx@yEp5*DL&&xh^ZR$h1wlSro~@h$=M65h(iGj?4*rmc1`!`zOn)h!^&G|Q`y7jJ=0@1#~Mf*m)`m|os zz7b`JAMRWnSLOs-BsCEKKR*5!CEJ@?ZN&SVj(9*=f0G^I_yB*?{p=09U1cb|uP!rW z<)G+#+H2osZxSBm{JZH>?H9|h6n(#G;2j+5^c#}xf0G3G|89JxpoLK6jkHY?;Q#ww zGOkSi;6CIeE-`Fx5W`&xllk}3mu zPrubN?6H4N@?>Eu-9CQzixK(9>ogAhKEL>}Gb(b6A?@3w$f^wcxY7Ay8+irnE^SJ&ZVyepe>R4BWjIUlk zs;(+M#l3rm<&t>%3W1yDkL#^#L+JI@ko3f%B;K89#=9TsL#(c0J=UlG(?F@~-OP^m z8tHHO#WG^5lK(;8=OxdHbF$tkD@r&}*etrie71^sjCEq4x+pF=l4bIE^2Z0P)) z$sX)=hRwh7F4nK?_~)1yjI4vCW^WOoLn52S*Yh7r^3N$CC@n_#Vc)_O3c13+7yiFG z`8^>KrOuyb#3t>|QU3kavftel(^VggmH3JC4EKFfip|HckMcATId^M0Bj5`g(%`y5RK=FS;SQAgJ9-@cNTBrR*;lpp$vv(&~YZ`jp)D zS%F(e)uag^?nSSco6KNW>iWf-sn$e2X^>T$Uf-J%6C?G#(^%wF)P`V3wXW*l4+^N@ zL1H`taDT53^?(lny42PPUPl)BUtau_Gqd8r068Vbv#AGsp>NdI8{U&z1u1#)w=y$8 z?jMgus<&aP^I zH?wCQ6nbX$+XIRf?6+qfQ1~wLs?Ff&kiQ{qXbq>??(x&fc86p SF5Zt)P4ov<6a8AP)WixPdP5=r diff --git a/source/_static/js/algolia.js b/source/_static/js/algolia.js index 3434bcab..6951b014 100644 --- a/source/_static/js/algolia.js +++ b/source/_static/js/algolia.js @@ -1,12 +1,14 @@ -docsearch({ - // Your apiKey and indexName will be given to you once - // we create your config - apiKey: '7e59277e32050e11c2e8915f1b09d6e2', - indexName: 'CodioDocs', - appId: '0MJO9504F8', // Should be only included if you are running DocSearch on your own. - container: '#docsearch', - // Set debug to true to inspect the dropdown - searchParameters: { - hitsPerPage: 20, - } +window.addEventListener('DOMContentLoaded', () => { + docsearch({ + // Your apiKey and indexName will be given to you once + // we create your config + apiKey: '7e59277e32050e11c2e8915f1b09d6e2', + indexName: 'CodioDocs', + appId: '0MJO9504F8', // Should be only included if you are running DocSearch on your own. + container: '#docsearch', + // Set debug to true to inspect the dropdown + searchParameters: { + hitsPerPage: 20, + } + }); }); diff --git a/source/_static/logo-dark.svg b/source/_static/logo-dark.svg new file mode 100644 index 00000000..6a5e5a65 --- /dev/null +++ b/source/_static/logo-dark.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/source/_templates/index.html b/source/_templates/index.html index 04c25d7c..2836d239 100644 --- a/source/_templates/index.html +++ b/source/_templates/index.html @@ -1,97 +1,102 @@ {% extends "layout.html" %} {% set title = _('Codio') %} {% block body %} + + -
-
- Codio Instructor Help Center -
-
- -
- Overview: Getting Started in Codio -
-
-
-
- Getting started with Codio including videos and tutorials. -
-
- Learn More - -
- - -
- Content Authoring -
-
-
-
- Authoring instructional content and assessments. -
-
- Learn More - -
- - -
- Developing Code -
-
-
-
- The Codio development environment. -
-
- Learn More - -
- - -
- Course Configuration -
-
-
-
- Creating courses, adding students, connecting to LMS TAs. -
-
- Learn More - -
- - -
- Teaching in Codio -
-
-
-
- Grading, viewing student work, remote toolkit. -
-
- Learn More - -
- - -
- Admin -
-
-
-
- LMS Integration, Organization settings, FERPA, Accessibility. -
-
- Learn More - -
- -
+ +
+ + + + + + + +
+
+
+ + +
+ + +

Overview: Getting Started

+

Videos, tutorials, and key concepts to hit the ground running.

+ Explore + + + + +

Content Authoring

+

Author instructional content and build auto-graded assessments.

+ Explore + + + + +

Developing Code

+

Use the Codio IDE, terminal, and environment features.

+ Explore + + + + +

Course Configuration

+

Create courses, add students, and connect to your LMS.

+ Explore + + + + +

Teaching in Codio

+

Monitor progress, grade efficiently, and use the remote toolkit.

+ Explore + + + + +

Admin

+

LMS integrations, org settings, FERPA, and accessibility.

+ Explore + +
+
+
+
-{% endblock %} \ No newline at end of file + +{% endblock %} diff --git a/source/_templates/layout.html b/source/_templates/layout.html index df4a026a..7ecb168e 100644 --- a/source/_templates/layout.html +++ b/source/_templates/layout.html @@ -1,5 +1,26 @@ {% extends "!layout.html" %} +{% block extrahead %} + {{ super() }} + +{% endblock %} + {% block footer %} {{ super() }} diff --git a/source/admin.rst b/source/admin.rst index 9219bbe4..437cd46f 100644 --- a/source/admin.rst +++ b/source/admin.rst @@ -8,7 +8,7 @@ Admin ===== .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: instructors/admin/integration/intro diff --git a/source/authoring.rst b/source/authoring.rst index c307817b..24dd5ca9 100644 --- a/source/authoring.rst +++ b/source/authoring.rst @@ -8,7 +8,7 @@ Authoring --------- .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: diff --git a/source/common.rst b/source/common.rst index 43302d58..9dc7e275 100644 --- a/source/common.rst +++ b/source/common.rst @@ -8,7 +8,7 @@ Developing Code =============== .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: common/develop/projects/projects diff --git a/source/common/develop/projects/projects.rst b/source/common/develop/projects/projects.rst index 98296cbc..8bbd4166 100644 --- a/source/common/develop/projects/projects.rst +++ b/source/common/develop/projects/projects.rst @@ -8,6 +8,7 @@ Developing Code .. toctree:: :caption: Projects + :maxdepth: 3 :hidden: project-settings diff --git a/source/conf.py b/source/conf.py index 56071e1c..b27e76ce 100644 --- a/source/conf.py +++ b/source/conf.py @@ -16,13 +16,30 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) +from sphinxawesome_theme.postprocess import Icons +from sphinxawesome_theme import ThemeOptions +from datetime import date + +from dataclasses import asdict # -- Project information ----------------------------------------------------- project = u'' -copyright = u'Codio 2025. All Rights Reserved' +copyright = f"Codio {date.today().year}. All rights reserved." author = u'' +# Global substitutions for reStructuredText files +substitutions = [ + ":tocdepth: 3", + " ", + ".. meta::", + " :keywords: Documentation,Sphinx,Python,Tailwind", + ".. |rst| replace:: reStructuredText", + ".. |product| replace:: Documentation", + ".. |conf| replace:: File: conf.py", +] +rst_prolog = "\n".join(substitutions) + # The short X.Y version version = u'' # The full version, including alpha/beta/rc tags @@ -94,17 +111,30 @@ # further. For a list of options available for each theme, see the # documentation. # -html_theme_options = { - "show_prev_next": True, -# "external_links": [ -# {"name": "Overview", "url": "/instructors/getstarted"}, -# {"name": "Authoring", "url": "/instructors/authoring"}, -# {"name": "IDE", "url": "/common"}, -# {"name": "Course Set Up", "url": "/instructors/setupcourses"}, -# {"name": "Teaching", "url": "/instructors/teaching"}, -# {"name": "Admin", "url": "/instructors/admin"} -# ] -} + +theme_options = ThemeOptions( + show_prev_next=True, + awesome_external_links=True, + main_nav_links={"Changelog": "/instructors/getstarted/support/changelog.html"}, + logo_light="logo-dark.svg", + logo_dark="logo-white.svg", +) + +html_theme_options = asdict(theme_options) + +# html_theme_options = { +# "show_prev_next": True, +# "logo_light": "_static/logo-white.svg", +# "logo_dark": "_static/logo-white.svg", +# # "external_links": [ +# # {"name": "Overview", "url": "/instructors/getstarted"}, +# # {"name": "Authoring", "url": "/instructors/authoring"}, +# # {"name": "IDE", "url": "/common"}, +# # {"name": "Course Set Up", "url": "/instructors/setupcourses"}, +# # {"name": "Teaching", "url": "/instructors/teaching"}, +# # {"name": "Admin", "url": "/instructors/admin"} +# # ] +# } # 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, @@ -216,12 +246,12 @@ html_additional_pages = { 'index': 'index.html' - } +} + html_css_files = [ 'css/codio.css', 'css/search.css', 'https://cdn.jsdelivr.net/npm/@docsearch/css@3' - ] html_js_files = [ @@ -229,6 +259,10 @@ ('js/algolia.js', {'defer': 'defer'}) ] -html_logo = "_static/logo-white.svg" +# html_logo = "_static/logo-white.svg" +html_logo = None +html_title = "Codio" html_favicon = "_static/favicon.ico" html_extra_path = ['robots.txt'] +html_permalinks_icon = Icons.permalinks_icon +html_show_sphinx = False diff --git a/source/getstarted.rst b/source/getstarted.rst index fdc59cbd..1efb1036 100644 --- a/source/getstarted.rst +++ b/source/getstarted.rst @@ -1,13 +1,13 @@ .. meta:: :description: Getting started with Codio including videos and tutorials -:name: getstarted +.. :name: getstarted Getting Started --------------- .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: instructors/getstarted/startlist diff --git a/source/index.rst b/source/index.rst index 1a215e52..14b6b5c8 100644 --- a/source/index.rst +++ b/source/index.rst @@ -3,8 +3,8 @@ Welcome to CodioDocs's documentation! .. toctree:: - :caption: Theme Documentation - :maxdepth: 2 + :caption: Documentation + :maxdepth: 3 Overview Authoring diff --git a/source/setupcourses.rst b/source/setupcourses.rst index 9fc9ed10..23231cc9 100644 --- a/source/setupcourses.rst +++ b/source/setupcourses.rst @@ -8,7 +8,7 @@ Courses Set up -------------- .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: instructors/setupcourses/courses diff --git a/source/teaching.rst b/source/teaching.rst index 75d41f26..77fbb0cf 100644 --- a/source/teaching.rst +++ b/source/teaching.rst @@ -8,7 +8,7 @@ Teaching ======== .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: instructors/teaching/viewstudentwork diff --git a/student-source/accessing-codio.rst b/student-source/accessing-codio.rst index bd29e7de..b81ffa7a 100644 --- a/student-source/accessing-codio.rst +++ b/student-source/accessing-codio.rst @@ -8,7 +8,7 @@ Accessing Codio =============== .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: diff --git a/student-source/courses.rst b/student-source/courses.rst index 07e2584a..a0d361de 100644 --- a/student-source/courses.rst +++ b/student-source/courses.rst @@ -8,7 +8,7 @@ Your Courses ------------ .. toctree:: - :maxdepth: 2 + :maxdepth: 3 :hidden: students/courses/courses diff --git a/student-source/develop.rst b/student-source/develop.rst index 2e6d6027..410b36d4 100644 --- a/student-source/develop.rst +++ b/student-source/develop.rst @@ -8,7 +8,7 @@ Developing Code =============== .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: develop/develop/projects/projects diff --git a/student-source/student.rst b/student-source/student.rst index 98f65283..70ed4e68 100644 --- a/student-source/student.rst +++ b/student-source/student.rst @@ -3,8 +3,8 @@ Welcome to CodioDocs's documentation! .. toctree:: - :caption: Theme Documentation - :maxdepth: 2 + :caption: Documentation + :maxdepth: 3 Accessing Codio Your Courses From 6e1bd9efe70753c34ef06b0af528d923b42c5753 Mon Sep 17 00:00:00 2001 From: Jairo Velasquez Date: Mon, 6 Oct 2025 14:04:27 +0000 Subject: [PATCH 3/3] Done --- .codio | 3 +- .github/workflows/deploy.yaml | 2 +- README.md | 2 +- source/_static/css/codio.css | 7 +- source/conf.py | 8 +- student-source/_static/css/codio.css | 29 ++++ student-source/_static/css/custom_body.css | 175 ++++++++++++++++++-- student-source/_static/css/custom_index.css | 12 ++ student-source/_static/favicon.ico | Bin 4220 -> 2556 bytes student-source/_static/logo-dark.svg | 7 + student-source/_templates/student.html | 119 +++++++------ student-source/conf.py | 62 +++++-- 12 files changed, 332 insertions(+), 94 deletions(-) create mode 100644 student-source/_static/css/custom_index.css create mode 100644 student-source/_static/logo-dark.svg diff --git a/.codio b/.codio index bf1af96f..4d189add 100644 --- a/.codio +++ b/.codio @@ -7,7 +7,8 @@ }, // Preview button configuration "preview": { - "Preview": "https://{{domain}}/build/html/index.html", + "Instructor": "https://{{domain}}/build/html/index.html", + "Student": "https://{{domain}}/build/html/student.html", "Visit Ungit": "https://{{domain4000}}/#/repository?path=%2Fhome%2Fcodio%2Fworkspace" diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 76a18753..2b4b1fce 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Setup env - run: pip install sphinxcontrib-applehelp==1.0.4 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-htmlhelp==2.0.1 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5 sphinx==4.2.0 sphinx-sitemap sphinx_code_tabs recommonmark git+https://github.com/codio/pydata-sphinx-theme.git@master + run: pip install sphinx==8.2.0 sphinxawesome-theme==5.3.2 sphinx-docsearch sphinx-sitemap sphinx_code_tabs recommonmark - name: Checkout uses: actions/checkout@v1 diff --git a/README.md b/README.md index c0f10843..b67ba7bd 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ If using Codio, put on the certified Python stack `Python Ubuntu 22.04 (pyenv)`. ### Install ``` -pip install sphinx==8.2.0 sphinxawesome-theme=5.3.2 sphinx-sitemap sphinx_code_tabs recommonmark +pip install sphinx==8.2.0 sphinxawesome-theme==5.3.2 sphinx-docsearch sphinx-sitemap sphinx_code_tabs recommonmark ``` ### Build diff --git a/source/_static/css/codio.css b/source/_static/css/codio.css index 200d25cd..cd9bd4a1 100644 --- a/source/_static/css/codio.css +++ b/source/_static/css/codio.css @@ -225,16 +225,18 @@ .bd-content a.reference { font-weight: 600; } + .small-text { font-size: 0.85em; } + .tiny { font-size: 0.75em; - } +} .float-right { float: right; width: 300px; margin-left: 50px; - } +} header img[src$="logo-white.svg"], header img[src$="logo-dark.svg"] { @@ -242,7 +244,6 @@ header img[src$="logo-dark.svg"] { width: auto !important; } -/* header .brand .site-name, */ header span.font-bold { display: none !important; } diff --git a/source/conf.py b/source/conf.py index b27e76ce..43f6d07e 100644 --- a/source/conf.py +++ b/source/conf.py @@ -19,7 +19,6 @@ from sphinxawesome_theme.postprocess import Icons from sphinxawesome_theme import ThemeOptions from datetime import date - from dataclasses import asdict # -- Project information ----------------------------------------------------- @@ -33,7 +32,7 @@ ":tocdepth: 3", " ", ".. meta::", - " :keywords: Documentation,Sphinx,Python,Tailwind", + " :keywords: Documentation,Codio", ".. |rst| replace:: reStructuredText", ".. |product| replace:: Documentation", ".. |conf| replace:: File: conf.py", @@ -62,6 +61,7 @@ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', + 'sphinx_docsearch', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', @@ -266,3 +266,7 @@ html_extra_path = ['robots.txt'] html_permalinks_icon = Icons.permalinks_icon html_show_sphinx = False + +docsearch_app_id = "0MJO9504F8" +docsearch_api_key = "7e59277e32050e11c2e8915f1b09d6e2" +docsearch_index_name = "CodioDocs" diff --git a/student-source/_static/css/codio.css b/student-source/_static/css/codio.css index 043e59e3..072fb8b7 100644 --- a/student-source/_static/css/codio.css +++ b/student-source/_static/css/codio.css @@ -225,3 +225,32 @@ .bd-content a.reference { font-weight: 600; } + +.small-text { + font-size: 0.85em; +} + +.tiny { + font-size: 0.75em; +} + +.float-right { + float: right; width: 300px; margin-left: 50px; +} + +header img[src$="logo-white.svg"], +header img[src$="logo-dark.svg"] { + height: 32px !important; + width: auto !important; +} + +header span.font-bold { + display: none !important; +} + +@media (prefers-color-scheme: dark) { + html { background: #0b0d17; } +} +@media (prefers-color-scheme: light) { + html { background: #ffffff; } +} diff --git a/student-source/_static/css/custom_body.css b/student-source/_static/css/custom_body.css index 5e9114f1..456eaea6 100644 --- a/student-source/_static/css/custom_body.css +++ b/student-source/_static/css/custom_body.css @@ -1,19 +1,174 @@ -body { - background-color: #02064e; +/* ========================================= + Codio Docs — Home (index) only + Pure theme background, centered layout + ========================================= */ + +/* Hide sidebars on the homepage and center content */ +/* Center & unbox the student page just like the home page */ +.student-page .bd-sidebar-primary, +.student-page .bd-sidebar-secondary { display: none !important; } + +.student-page .bd-content, +.student-page .bd-article-container { + max-width: 1200px; + margin-inline: auto !important; + padding-inline: 1rem; + background: transparent !important; +} + +/* Share the same theme tokens */ +html[data-theme="dark"] .student-page, +[data-theme="dark"] .student-page { + --text: #e6eaf2; + --muted: #9aa3b2; + --border: rgba(255,255,255,0.14); + --surface-hover: rgba(255,255,255,0.06); + --brand: #6ee7ff; + --brand-strong: #3dd8ff; + --ring: #9feaff; + --shadow: 0 10px 26px rgba(3,8,48,0.35); +} +html[data-theme="light"] .student-page, +[data-theme="light"] .student-page { + --text: #0b1020; + --muted: #475569; + --border: rgba(0,0,0,0.12); + --surface-hover: rgba(2,132,199,0.05); + --brand: #0ea5e9; + --brand-strong: #0284c7; + --ring: #38bdf8; + --shadow: 0 10px 24px rgba(2,132,199,0.08); +} + +.index-page .bd-sidebar-primary, +.index-page .bd-sidebar-secondary { display: none !important; } + +.index-page .bd-content, +.index-page .bd-article-container { + max-width: 100%; + margin-inline: auto !important; + padding-inline: 1rem; +} + +/* Make every wrapper transparent so there is NO boxed panel */ +.index-page, +.index-page .bd-main, +.index-page .bd-content, +.index-page .bd-article-container, +.index-page .bd-article { + background: transparent !important; } -.footer { - border-top: none; +/* ------- Theme tokens (only for the homepage components) ------- */ +html[data-theme="dark"] .index-page, +[data-theme="dark"] .index-page { + --text: #e6eaf2; + --muted: #9aa3b2; + --border: rgba(255,255,255,0.14); + --surface-hover: rgba(255,255,255,0.06); + --brand: #6ee7ff; + --brand-strong: #3dd8ff; + --ring: #9feaff; + --shadow: 0 10px 26px rgba(3,8,48,0.35); } -.container-xl .row { - justify-content: center; +html[data-theme="light"] .index-page, +[data-theme="light"] .index-page { + --text: #0b1020; + --muted: #475569; + --border: rgba(0,0,0,0.12); + --surface-hover: rgba(2,132,199,0.05); + --brand: #0ea5e9; + --brand-strong: #0284c7; + --ring: #38bdf8; + --shadow: 0 10px 24px rgba(2,132,199,0.08); } -.container-xl .no-sidebar { - display: none !important; +/* Fallback to OS pref if the site doesn't set data-theme */ +@media (prefers-color-scheme: light) { + html:not([data-theme="dark"]) .index-page { + --text: #0b1020; + --muted: #475569; + --border: rgba(0,0,0,0.12); + --surface-hover: rgba(2,132,199,0.05); + --brand: #0ea5e9; + --brand-strong: #0284c7; + --ring: #38bdf8; + --shadow: 0 10px 24px rgba(2,132,199,0.08); + } } -.container-xl .d-none { - display: none !important; +/* ------- Hero ------- */ +.home-hero { padding: 5rem 1rem 1.5rem; text-align: center; } +.home-title { color: var(--text); font-size: clamp(2rem, 2.8vw + 1rem, 3rem); margin: 0 0 .6rem; } +.home-subtitle { color: var(--muted); margin: 0 auto 1.8rem; max-width: 62ch; } + +/* (Search form is commented out in your HTML, but styles left here in case you re-enable) */ +.home-search { + display: inline-flex; gap: .5rem; align-items: center; + background: transparent; /* no panel */ + border: 1px solid var(--border); + border-radius: 999px; padding: .5rem; + box-shadow: none; +} +.home-search input[type="search"] { + min-width: clamp(260px, 42vw, 560px); + background: transparent; border: none; color: var(--text); + outline: none; padding: .75rem 1rem; font-size: 1rem; +} +.home-search input::placeholder { color: var(--muted); } +.search-btn { + display: inline-flex; align-items: center; gap: .5rem; + border: 1px solid transparent; + background: linear-gradient(180deg, var(--brand), var(--brand-strong)); + color: #001; font-weight: 700; padding: .7rem 1rem; + border-radius: 999px; cursor: pointer; + box-shadow: 0 10px 24px rgba(0, 190, 255, .18); +} +.search-btn:focus-visible { outline: 3px solid var(--ring); outline-offset: 2px; } +.search-btn .icon { width: 20px; height: 20px; } + +/* ------- Sections ------- */ +.home-main { padding: .5rem 0 3rem; } +.home-container { max-width: 1100px; margin-inline: auto; padding-inline: 1rem; } +.section { margin-top: 1.25rem; } +.section-title { color: var(--muted); font-weight: 600; letter-spacing: .2px; margin: 0 0 1rem; } + +/* ------- Cards: transparent by default (no fill), subtle outline ------- */ +.card-grid { + --min: 260px; + display: grid; grid-template-columns: repeat(auto-fit, minmax(var(--min), 1fr)); + gap: 1rem; align-items: stretch; +} +.card { + display: grid; grid-template-rows: auto auto 1fr auto; gap: .5rem; + padding: 1rem; border-radius: 16px; text-decoration: none; color: var(--text); + background: transparent; /* <- no box */ + border: 1px solid var(--border); + box-shadow: none; + transition: transform .2s ease, background-color .15s ease, border-color .15s ease; +} +.card:hover { transform: translateY(-2px); background: var(--surface-hover); border-color: var(--brand); } +.card:focus-visible { outline: 3px solid var(--ring); outline-offset: 2px; } + +.card-icon { + width: 36px; height: 36px; display: grid; place-items: center; + border-radius: 12px; + background: linear-gradient(180deg, var(--brand), var(--brand-strong)); + box-shadow: 0 8px 18px rgba(0, 190, 255, .2); +} +.card-icon svg { width: 22px; height: 22px; fill: #001; } + +.card-title { font-size: 1.05rem; margin: .25rem 0; } +.card-desc { margin: 0; color: var(--muted); } +.card-cta { margin-top: .5rem; font-weight: 700; color: var(--brand); display: inline-flex; gap: .35rem; } +.card-cta::after { content: "›"; font-size: 1.2em; transform: translateY(-1px); } + +/* Reduced motion */ +@media (prefers-reduced-motion: reduce) { .card, .search-btn { transition: none; } } + +/* Small screens */ +@media (max-width: 480px) { + .home-search { width: 100%; } + .home-search input[type="search"] { min-width: 0; width: 100%; } } diff --git a/student-source/_static/css/custom_index.css b/student-source/_static/css/custom_index.css new file mode 100644 index 00000000..729bfd77 --- /dev/null +++ b/student-source/_static/css/custom_index.css @@ -0,0 +1,12 @@ +/* Slight width nudge only (kept minimal) */ +.index-page .home-container { max-width: 100%; } + +/* Ensure any Bootstrap-like main column stays centered on the homepage */ +@media (min-width: 1200px) { + .index-page .col-xl-8 { + flex: 0 0 91.66667% !important; + max-width: 91.66667% !important; + margin-left: auto !important; + margin-right: auto !important; + } +} diff --git a/student-source/_static/favicon.ico b/student-source/_static/favicon.ico index 8d393ea6d4c6b5bbb2aa1b6455726c3a2cbc32de..fae4ef6857a2e5bbf5aabf88f2722984997c4add 100644 GIT binary patch literal 2556 zcmV<|BMM6+kP&iEJ2><{ukHKRQccQ3mB*#}?yZqr^KM;!BwvFiC z`_I~M8v|+EWC~vYX3wB)8$mt>2kDu-p7}$_5R7bqqAa9T z0X=7jK2-|o`PP|Rg>`b|RDs<)ajMYn9oQ?ldvIRi{d-`i3h*7&sY1L5bgCfl!8|I= z7a;#D&~HIB4r$LbfZ!DB=ik!XE7X{ma|1gWkpP!*o0Swc52{@k4 zNx&jZ^G8K+HO(s-sHbRD2*advDOgW>DFyX}M#a#MtK?uk&d5PMCa55Wk(DIuM!X~( zjr5Y>NCp+fKn}7nkgY6SkzZxOlP_h#kt&Q~DGm0EH0&yAxH^=EqyMDA8)>LtN<-(Q z!O4Tp{Xh5r-2eaT`{+-9rX@4;li(`+DIUtiJ|OS(lHRP+C7& z)^I7`U7FBbFKd9ToeJ&sTMmi!GD`>!3x`4JW(h|%0exXJ$;eRGYQHg;aA$X8Dcp(EfiG>>xxJf*` zohZOfV&X9QkDJ8B&3oJ=Hg29PP2%IlZ-d0h&S$;E$#48sC06dfx|3+x*iYQzg$$FI zn#9bDk9vulxBkfzIbUPnaEl$HzIiF}^X!)_?zi{){5`Y%S>Auj-Te?4m3_j^vDRIZIayfzs4oB}}ou!)mb#aw)#pR7K3Brc}W9OXC3H~3(4;i{Os57d(*evbrx z{lc8y6Y&~;8@#le6?VBm~F5s8>*b>CM#kM))$8CUg`EOUOx%wD?@jn zTbyf zL|f50z?tx~MzbS23T7}59%$B~Gl04G!Iv~Upi{wgK6n`i1niv;m}ZI%!&!Y`G;7{s zFVq;Y!!a+m7%{BICVl!iFSujh9h^lu@LHl@)`4Q~Y{Z9--fx@W{j zShC@AEre&p>@`@@VX_F}Plow5FzN6(3guVSCTP-Ou?yvs;eHQIIvkEd`i$HNPC5*Z zLi%LbD>%8hSB3VUqc_5n#%`5OXrCB8Q+U$uT-uuu|GD8mIv{d!XPJfgi9KNIg0$5Q zRw4g$^Wo@($j0zWC-hIn3wG~@NXNjISpqPdANe&$q;(9ZbWK7qJ@w_aDme zDY^FN=Rx&wI2>-Z%@Up`^XpGIgl%Ha*vHW$n{THfa$K2zAH5belKJ@Sn332^Hb#s) z^Rz~b=jQ7vMT#r)_oEag-ZG!>H9{ozn*9_X5}W5=#D>J?{TFc|u@Ue^Oh{}bd=U>4 z8xg;+ksz^=aZgcTVIw4`2%yDC$wTm6896@=yf2KPL&&AwNct!Rn-(MLbPBY=2%A%Y zrQJx&r{KCOM%|o(YWc|s{OA-;buc3Hn}KvHM(3OYNJpb}PJyGN(L1Mr(a~t0Q=sT* zbRSRQQ6Jc7&p8E!=3)Ujo>Cy_L$P2S`+tR?qX?p_$&?I>13fJBUxz3N)}GYds!IBAPa${lZ1{W4<+Hl$Vw7+BcCN9jL^tI z&9SW<^y6YVu;XZ?pyR|=3i?Sw3hX2r8K^nsP6jTf2~Q=!aq3nA{B%JA>~xIq=Q-nm zzjziJ^m)!apwG@mgFVj#E%s~@JVc&nqMsMIb2b@PxZ5ykgF45=?E-W*IaZiEW|{_Z zj;Y!O-k#ZXc#gN8X&<8Ph^c?>u;#v{N4r3pv&`ZWX-j5vgR`DlZBe#nc3X_CndL)- zt(ooj_==eI7F{c5zs1&?d2ErjW1S^BX%vb(VSle2AyjmN`FPVCh-U z{9A`4V_AqTjH;eRX&r`)Wr1!SeyX0uY9sWlwk+H@LXL@9$TmWa8CckHgcv`t(BsHq zrE0e<{*A$j`Lbm>#^)~)V%jas)K&%?rnM~J?Jnvu;f{7&miBfie{37hTPn7f;|H0R@=XbQob^%jut3@4k&wE{_`80-?20tiBMwnBkNO~=`GMSEjrhA=ZTGcz+YGk46)%*@Qp z%*@Qp%$f7fJ7>nq9#Ul;qrXj;9avcfb#4O-i1dc5qjU@#;8aeV^6$KlBc+};${w&x zmpaY@(nbHLw8tBG+P}0*yK?ItcpD>k)|6qWQYJe{9npV>lB~9k9;hJMPF!hUK)3#X zMcRV9ySux)ySux)ySux)JM8rMYTEGwr$7B`p;03WLCQ;9WMu*`vP6bi2)SA00O|xCp)%-+0>4$ zMtB4mfCt1GKr)hNW;Xb0On8x|Mr`CG0#u*}QP2U_zzMhl*Wk%mUIH$`F<6}d5ugQ> z=&Lj@Fxb!mQjh?n>wq@^D#GA(ofobIlF+k*QTgEu0di1z0{k&x@DF~#H~975cgC{! zzUf`Zfc+Cw-$h=vNgm*U7})GcIv2ig3`RzC0^fk^^wWUTk09EkG z&Lu^v8gS&~)CT1RTUB5NXJmp`c?X(4@YV{6sxKrK)RSGh~r2QR2_<4AGDImX>w$dpgCB+NCm@e zd_=_&-*BTqiksan{a;>|CBRrPS(Jjlh*Bhu9Kucvq!->1Ez{f}=Kh1~9;TWJctP zcmB{JX?#mWg_c{AhNB)!Cp9@9o0MpEf;}m9;zaTh7%WP@0W*mQuJ$}OQd2{)u1O5g zN7G9^@H~2(Bm#s#C8s4DB+<+-?4+iSzs#&=3l+7+if5U#(U+0`rIG*TQT}8&X4yzI zS#{Vf6AoDx;oK;HN{ZkN!$@6NCmyPF(f_c+HE-EjCGp@~6eSAL;b_0=2W8Go%G~4BFigz==wQ3X2bps(92o6TpK|73k>F*8* z-Y9|xN7f7OWKyTOVdO-5T>E;!+7#`wGRUi}ka*0C+xt z6bwu%07fk+t?3h7hXr@CLC`32QuVDXfz+Er0*VCQR0=emqk^~)(#1FO7wVq2niI2j zN}wz%Ox{2W8!xkgr9Oc34mO9Z^md@vVSzyo1d?cELkqMN^_(1ISnDa%!{*o9N zD|mzK-f)rjW%Cl+Vzofc44pC5#r*A-n<-JqWKha}iHRx5yN01_S_V;yV|=UU81Ll* zV8uu2*2E+*78Jm(;$(wf8*eC`oV0&F&oQ%+`VGwQNpW%;fs=cs=k;NYxNzl|4e3^t zB-UZlf>9=Ti3bi_Xgk9j${%crRGlUwHvmrGbl$1PpXRd<&IA$zFtlEfY{i92U|74g z6j-`U^*-9S+odqwsy^7dKHM`iKgoHzM*1CS2MQTbA^!s1b4LIUE|;8q14G}BN{VFr z(OVaaw#M28h!Y?3OKJ+veMeIFktw&w1kKddqG6*9rHwn5aXvZtp2cldFT@}i?5?@LFwVa z&CF*}=^Mf4vyCpfnazCj`9SpjE6pIQE=I`I8XG{L*&KPb-==Ye>mEA+TR!g^@&9$v;#T z-;=j_Daiugq4l>VFCW_6SCX0k%1Omwv|f3xikPJx(eRO0gcwj^Ho?sTG~JbtsXRCt z5&lIf_AaeBkg9!z*w+{gC7Gxj>q|S=cu$1-;(`3tr!@>C597VPQ*%oU+vbn*X00A( zGNZM8Eex*cRIvv2d^KW2ki*J!afb8lrDIozrStNEv9<90(q)_v{XE0Nrv~B=i3ajd z$-|@nDDnzcYMww|@lcCqRjfsefWavb%l87dtq$vAS;v(dL}2oJ$J_G@ap~3KK;{Ng z!1iAE06x=sgsChz=_}{cdJN8LTdd}9>#*K6Uo}Z%uerA>IE>r^N4s>%N6x#t}9 zS2@*wP6)P0cJ*l;LwT4ShNwJVyMpMOn_V=k>qD~|bY|jb>pBUj7#7fk^E)|Ywv&Wc zgt*#F&5vP|0^mK2&mP$sX7aE&Qorgpf;fo^Db8{hldD&ve$b6#JK|-=qB~ z@-{23KCi08IO<2QM1>4jnXCG-h}hqx)4|j$B0My_sS_l$sr>x3Je1sxDf^U_=k;R-dW&1$$=ZwfhcA?8=lQYt*X2 zM!jxd3WtWb@P)BHHHl3&VU~Q-d8A7g-zYR=tVEN&(z8C;CPw~O9)@mGyo1 zcGNu59nE|m7XWkb$ev-nj`6K}Ke;LI+*|k%z~}D2LI+e|Yuu0rE3Gu*^wU|i_0!K-{WRaFpKf0sc0!;4 zgnN8?odisA?|L1dzUbx@yEp5*DL&&xh^ZR$h1wlSro~@h$=M65h(iGj?4*rmc1`!`zOn)h!^&G|Q`y7jJ=0@1#~Mf*m)`m|os zz7b`JAMRWnSLOs-BsCEKKR*5!CEJ@?ZN&SVj(9*=f0G^I_yB*?{p=09U1cb|uP!rW z<)G+#+H2osZxSBm{JZH>?H9|h6n(#G;2j+5^c#}xf0G3G|89JxpoLK6jkHY?;Q#ww zGOkSi;6CIeE-`Fx5W`&xllk}3mu zPrubN?6H4N@?>Eu-9CQzixK(9>ogAhKEL>}Gb(b6A?@3w$f^wcxY7Ay8+irnE^SJ&ZVyepe>R4BWjIUlk zs;(+M#l3rm<&t>%3W1yDkL#^#L+JI@ko3f%B;K89#=9TsL#(c0J=UlG(?F@~-OP^m z8tHHO#WG^5lK(;8=OxdHbF$tkD@r&}*etrie71^sjCEq4x+pF=l4bIE^2Z0P)) z$sX)=hRwh7F4nK?_~)1yjI4vCW^WOoLn52S*Yh7r^3N$CC@n_#Vc)_O3c13+7yiFG z`8^>KrOuyb#3t>|QU3kavftel(^VggmH3JC4EKFfip|HckMcATId^M0Bj5`g(%`y5RK=FS;SQAgJ9-@cNTBrR*;lpp$vv(&~YZ`jp)D zS%F(e)uag^?nSSco6KNW>iWf-sn$e2X^>T$Uf-J%6C?G#(^%wF)P`V3wXW*l4+^N@ zL1H`taDT53^?(lny42PPUPl)BUtau_Gqd8r068Vbv#AGsp>NdI8{U&z1u1#)w=y$8 z?jMgus<&aP^I zH?wCQ6nbX$+XIRf?6+qfQ1~wLs?Ff&kiQ{qXbq>??(x&fc86p SF5Zt)P4ov<6a8AP)WixPdP5=r diff --git a/student-source/_static/logo-dark.svg b/student-source/_static/logo-dark.svg new file mode 100644 index 00000000..6a5e5a65 --- /dev/null +++ b/student-source/_static/logo-dark.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/student-source/_templates/student.html b/student-source/_templates/student.html index e4976b6e..772b17e0 100644 --- a/student-source/_templates/student.html +++ b/student-source/_templates/student.html @@ -2,67 +2,60 @@ {% set title = _('Student') %} {% block body %} -
-
- Codio Student Help Center -
-
- -
- Accessing Codio -
-
-
-
- Joining a course, passwords, payments. -
-
- Learn More - -
- - -
- Your Courses -
-
-
-
- Dashboard, courses, assignments, grades. -
-
- Learn More - -
- - -
- Tools -
-
-
-
- Code Playback, Dyslexia support, Virtual Coach. -
-
- Learn More - -
- - -
- Developing Code -
-
-
-
- The Codio development environment. -
-
- Learn More - -
- -
+ + +
+ + +
+
+
+
+ + +

Accessing Codio

+

Join a course, manage passwords, and payments.

+ Explore + + + + +

Your Courses

+

Dashboard, assignments, grades, and deadlines.

+ Explore + + + + +

Tools

+

Code Playback, Dyslexia support, Virtual Coach.

+ Explore + + + + +

Developing Code

+

The Codio IDE and development environment.

+ Explore + +
+
+
+
-{% endblock %} \ No newline at end of file +{% endblock %} diff --git a/student-source/conf.py b/student-source/conf.py index e5efb422..ac5fa02b 100644 --- a/student-source/conf.py +++ b/student-source/conf.py @@ -16,13 +16,29 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) +from sphinxawesome_theme.postprocess import Icons +from sphinxawesome_theme import ThemeOptions +from datetime import date +from dataclasses import asdict # -- Project information ----------------------------------------------------- project = u'' -copyright = u'Codio 2025. All Rights Reserved' +copyright = f"Codio {date.today().year}. All rights reserved." author = u'' +# Global substitutions for reStructuredText files +substitutions = [ + ":tocdepth: 3", + " ", + ".. meta::", + " :keywords: Documentation,Codio", + ".. |rst| replace:: reStructuredText", + ".. |product| replace:: Documentation", + ".. |conf| replace:: File: conf.py", +] +rst_prolog = "\n".join(substitutions) + # The short X.Y version version = u'' # The full version, including alpha/beta/rc tags @@ -45,6 +61,7 @@ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', + 'sphinx_docsearch', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', @@ -94,17 +111,28 @@ # further. For a list of options available for each theme, see the # documentation. # -html_theme_options = { - "show_prev_next": True, -# "external_links": [ -# {"name": "Overview", "url": "/instructors/getstarted"}, -# {"name": "Authoring", "url": "/instructors/authoring"}, -# {"name": "IDE", "url": "/common"}, -# {"name": "Course Set Up", "url": "/instructors/setupcourses"}, -# {"name": "Teaching", "url": "/instructors/teaching"}, -# {"name": "Admin", "url": "/instructors/admin"} -# ] -} + +theme_options = ThemeOptions( + show_prev_next=True, + awesome_external_links=True, + main_nav_links={"Changelog": "/instructors/getstarted/support/changelog.html"}, + logo_light="logo-dark.svg", + logo_dark="logo-white.svg", +) + +html_theme_options = asdict(theme_options) + +# html_theme_options = { +# "show_prev_next": True, +# # "external_links": [ +# # {"name": "Overview", "url": "/instructors/getstarted"}, +# # {"name": "Authoring", "url": "/instructors/authoring"}, +# # {"name": "IDE", "url": "/common"}, +# # {"name": "Course Set Up", "url": "/instructors/setupcourses"}, +# # {"name": "Teaching", "url": "/instructors/teaching"}, +# # {"name": "Admin", "url": "/instructors/admin"} +# # ] +# } # 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, @@ -230,6 +258,14 @@ ('js/algolia.js', {'defer': 'defer'}) ] -html_logo = "_static/logo-white.svg" +# html_logo = "_static/logo-white.svg" +html_logo = None +html_title = "Codio" html_favicon = "_static/favicon.ico" html_extra_path = ['robots.txt'] +html_permalinks_icon = Icons.permalinks_icon +html_show_sphinx = False + +docsearch_app_id = "0MJO9504F8" +docsearch_api_key = "7e59277e32050e11c2e8915f1b09d6e2" +docsearch_index_name = "CodioDocs"