From 4ef757c49fff362242bd212d46c1656966a6b3ba Mon Sep 17 00:00:00 2001 From: Adeeb Shihadeh Date: Sat, 6 Jul 2024 08:51:36 -0700 Subject: [PATCH] remove old docs (#32917) --- .github/workflows/docs.yaml | 1 + docs/Makefile | 53 ------------- docs/_static/favicon.ico | Bin 15086 -> 0 bytes docs/_static/logo.png | 3 - docs/_static/robots.txt | 2 - docs/c_docs.rst | 87 --------------------- docs/conf.py | 147 ------------------------------------ docs/index.md | 42 ----------- docs/overview.rst | 72 ------------------ pyproject.toml | 3 - uv.lock | 41 ---------- 11 files changed, 1 insertion(+), 450 deletions(-) delete mode 100644 docs/Makefile delete mode 100644 docs/_static/favicon.ico delete mode 100644 docs/_static/logo.png delete mode 100644 docs/_static/robots.txt delete mode 100644 docs/c_docs.rst delete mode 100644 docs/conf.py delete mode 100644 docs/index.md delete mode 100644 docs/overview.rst diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 6428729055..908f06e034 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -27,6 +27,7 @@ jobs: name: build docs runs-on: ubuntu-latest timeout-minutes: 45 + if: false # TODO: replace this with the new docs steps: - uses: actions/checkout@v4 with: diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 09103e206e..0000000000 --- a/docs/Makefile +++ /dev/null @@ -1,53 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -OPENPILOT_ROOT = `git rev-parse --show-toplevel` - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -DOCSDIR = "$(OPENPILOT_ROOT)/docs" -SOURCEDIR = "$(OPENPILOT_ROOT)/build/docs" -DOCSBUILDDIR = "$(OPENPILOT_ROOT)/build/docs" -BUILDDIR = "$(OPENPILOT_ROOT)/build" - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(DOCSBUILDDIR)" $(SPHINXOPTS) $(O) - -clean: - @echo "Cleaning build folder..." - rm -rf "$(BUILDDIR)" - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @echo "Cleaning build folder..." - rm -rf "$(BUILDDIR)" - mkdir -p "$(DOCSBUILDDIR)" - - @echo "Copying docs & config to build folder..." - cp -a "$(DOCSDIR)" "$(BUILDDIR)" - cd "$(OPENPILOT_ROOT)" && \ - find . -type f \( -name "*.md" -o -name "*.rst" -o -name "*.png" -o -name "*.jpg" -o -name "*.svg" \) \ - -not -path "*/.*" \ - -not -path "./build/*" \ - -not -path "./docs/*" \ - -not -path "./xx/*" \ - -exec cp --parents "{}" ./build/docs/ \; - - @echo "Building rst files..." - sphinx-apidoc -o "$(DOCSBUILDDIR)" ../ \ - ../xx ../rednose_repo ../notebooks ../panda_jungle \ - ../third_party \ - ../panda/examples \ - ../scripts \ - ../selfdrive/modeld \ - ../selfdrive/debug \ - $(shell find .. -type d -name "*test* -not -path "**.venv**" \") - - @echo "Building html files..." - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(DOCSBUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico deleted file mode 100644 index 976929954f3dacd1c0d86fd95b2485f1f324a527..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 15086 zcmcgz3vg8B6}|`-B#+%lAPIpaAR#CkAVEM|(P4Orj25S32gg=Ksk{Z^V}=UEM*s!K z3X}?11Vsr|d8)i66)hnWN)jX`kThk0&`=;iz$83Qzwc-7a(DOc?!CL)?#!3__#fw- z|3CjZ=Rfz4rZv-=Ydw2vxTb0O>6+F@)3mfS*Rxa8s_@QmS0 zz4~>zaf#$#r!%%$Y;1Jf*x0E4zze`qU_0=4paM7olmfeemB1^&5Fpv%h-n^4UhMSc za70IghXKGlzz@J#;3^0a1jW`Z?N(P^syJ1 z=x{_OhQnK+w&1%3Xbc3l0Hhg=FT3TOyCPsDXx$cw7rSNXFCP8o0cQXYzM`XVlc=ax z5);$fZ7j=;7fpd>*kUCCMLF(apT6y(4m8+eftC@2jwx= z3*(+^>KA4_S$zk)l8rtJ&3GXHDJdP~z<~o&UtcfZe*0H>>7^It?z`_)a}gmqDnWa= zRep{2(5@G7z>Igk)5rgtZ+43QyLRoG9654C^77u4?%lfyWr%=Y9S1#IGN67s@Hg@q z2;^8{p>)js{yD+;!z zpErsiM~@zrM;{#?t_-xTBh7S&a-l5W4!>q~ITz?lrcQl9E?n@Gp|Y}4h71`Lt}g90 z^V8sED8RTRq_H=)qYO@GjJ*2lbZKmC@R)~^k^_>J)gzpFpdXrOoCA#4t$6pTk%w^a zDMPzoI)}a6c{5yzBkZE=`#-S*~8a>LCODT(4f4;mEMm>2%zJd1wV%8+Ce-zH$z_ zbm=4|B_$sG^I`t{d4A{40w1M_Z<0}uzLx$ioW26Kr3`PqHP?s#%F3gXnb|$mIXDlV zxsMwT)c-H}kBVw3k390QT)I^6Ap_%#oSdnl+SBXcnR`*{K5bIKF$|}ic`ThOT5`v&-3QJ9qJljZf30= zKF#Xt`pvy0<4^7fwr$%gD^`3c6DEv<54#I--R<((XMZu}f9={YBrYyCl<{YN>0>jV zti0oxGR}GW>EB3cX^D@IBD2&F+DXcD?%X+3{=fhJJGGY%VGT1!Hs1=b{_4=T*45RS z@@4g9Sy`E+rF9HtugN^$M8MX5g|aX%7(RTM)YjHoWz%oHii*SV(Vau#pZU8%0DYNd z{o_0*Cbp9;TQ>XU$xZ?HHeI{kVb_Lo%qIh>K)D_MIrj9Y7cXA4!=~T5<>iOujyuxq zjz4p0$Qi5HKi@9@bLQmv<;QM8adEM9?AYEe|Hw5)w`B|s-p2rpCoJg@Z5?f1q<%Yg zY*+TxDt%YIcMS1AW6*zEZBJWn77K(b5B-`=+j#-J4$%3>c;15NKU(F#O&e##)-GdE z=DBp=ZIOqqh(}^{{&_{aen73o_VU38%R(J)k9Nn8AD7;}d)cu)+&eyLrQO(JGsfQG%|D;PdpF=8!DL{(!#s0Eg>O7>N1jusP9cB# zke%4=Kj3YU8SnZ#ls^Mp4kiQF+l(2%4|xu*T)85-xic-tlHbe#8~DX-%z5nEi-PY=#qi+5LA~aXP-XVD(AUz;|5{QytK4b7~69nGkWwW z72_~=vf-=n4JEplfhF6wj4{9)*F(@X&AA|dx8LrN4jqytHMN7%ag2lVPd50z0($(0 z5|I-FpwBf;yL1?^q_gBzht)Q&dNsIC2Th!ai0lvj@>?o>+-bm)95(9lTmBlLA9%kd zvYg-S&E=>2f)3-QY9O547uVG(fH|BY;5(w<-EVU3dj~n1gJu_iv3EW|zs-GIpuH$% zWv;Rc*aR^5mkGXq=1bxK_XcbHR`8Ju3<9{Ho)0ju!Q2eKr1P=EhY`dyvm{n&#lOK+~G@nu~KpypkyXT<3L`rlC3-Xj%iWsje%cD>O$3npVwg z%bV8%J|hC~xHi+YT)y{rWtq)iuB*Pfn)F-1a=cep13%S#Z{Sy#L&*nubUAgo^>M(E zsBv+RQ#HE5OZPbH<0`q$Zj5z9Dz9|PX~08(`O*Y&3ncl85!xq_=(>r8E5l+&hyWYQQtUh z#H-(^7b(D0M2TJv9xqm-T9(<%?thpEPSz;gnCypw<0#xkx0=H=F}U*`_VckkZq zK3in0>*xLm-gnh`z&(9!Aphz!CgkC+yE0_&-aiLxGec!MP2~t?N$4$SswpRM}yVuGX&~Fx7rB7P=K8)uonJ=aM{MNL2^Ve?r zHoiU5cki=8pLCLw6P5jAZltJauk75pQ|8W{qkIGR;KtwUufJwRe#Q?wg3+hkojRq+ znl<^t{l4)>ePiyzJLmWQ`+u^s1{lLE3q~I{Lf(D%9V6MG_sky#>lfv;JL3V`WYhW_ z_db1k%ZU>wg3>frU~Ylq=C5DZd&Y8E0O!H9F4yJ4d=b|G&r*1w-Sp;wwqe17_gr~Ezq-E+ zknO$2jO~ zxqttk%c4aKRougK#YII$vTWHBb=ICd>h-+%r#y_S({wt4uBgXx;9S%J9^=4yB@OzY z&Ye@0Phgz@^UXMeakZ`g0deWWFtpnR_^eIxpabO|Ji4Aae*9kn{NF}Y$T{3+*41_1N7%hfCm86Uhv)l%m7Yu-^Q3m*J-@d_2}QY zpAERr;*uRa#{x@%tJJ-hUw%>ejr`eXpK-@xDAW6(F02AnAIwAGembDmHQUoxOq@7g z{cpyHA1+5;y`#6!=9i+V3z`p>!f2IFC!#HBZqf%2-qrNBbJRSQs)MFmCKk&BU zov~ceeB+JR)cOABo*QkpmN}+-&DxU|eN^ARz2(fAGg45n%ghFrqwNXr_O$Edm*3mC zpFDW5OywBvzrU|H51ilQ#`bJGc&&gC( zRjK_9$8~-a;@puRwgWgu#{lYjtl2Wg zd!DP{cyLVjpr7MtNBt-QsHe1Z9^Wb&Qjz;b{ - system/loggerd/README.md - Driver Monitoring - Process Replay - -cereal -========= - -.. toctree:: - :maxdepth: 4 - - cereal/README.md - cereal/messaging/msgq.md - -models -========= - -.. toctree:: - :maxdepth: 4 - - models/README.md - -opendbc -========= - -.. toctree:: - :maxdepth: 4 - - opendbc/README.md - -panda -========= - -.. toctree:: - :maxdepth: 4 - - panda/README.md - panda/UPDATING.md - panda/board/README.md - panda/drivers/linux/README.md - panda/drivers/windows/README.md - - -rednose -========= -.. toctree:: - :maxdepth: 4 - - rednose_repo/README.md - - -tools -========= -.. toctree:: - :maxdepth: 4 - - tools/CTF.md - tools/joystick/README.md - tools/lib/README.md - tools/plotjuggler/README.md - tools/replay/README.md - tools/serial/README.md - Simulator - tools/ssh/README.md - Webcam - tools/cabana/README.md diff --git a/pyproject.toml b/pyproject.toml index fc2356645b..4b20c84e9f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,9 +66,6 @@ dependencies = [ [project.optional-dependencies] docs = [ "Jinja2", - "sphinx", - "sphinx-rtd-theme", - "sphinx-sitemap" ] testing = [ diff --git a/uv.lock b/uv.lock index 6433b53524..6a9f155df7 100644 --- a/uv.lock +++ b/uv.lock @@ -2286,9 +2286,6 @@ dev = [ ] docs = [ { name = "jinja2" }, - { name = "sphinx" }, - { name = "sphinx-rtd-theme" }, - { name = "sphinx-sitemap" }, ] testing = [ { name = "coverage" }, @@ -6447,32 +6444,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/b4/fa/130c32ed94cf270e3d0b9ded16fb7b2c8fea86fa7263c29a696a30c1dde7/sphinx-7.3.7-py3-none-any.whl", hash = "sha256:413f75440be4cacf328f580b4274ada4565fb2187d696a84970c23f77b64d8c3", size = 3335650 }, ] -[[distribution]] -name = "sphinx-rtd-theme" -version = "2.0.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/fe/33/2a35a9cdbfda9086bda11457bcc872173ab3565b16b6d7f6b3efaa6dc3d6/sphinx_rtd_theme-2.0.0.tar.gz", hash = "sha256:bd5d7b80622406762073a04ef8fadc5f9151261563d47027de09910ce03afe6b", size = 2785005 } -dependencies = [ - { name = "docutils" }, - { name = "sphinx" }, - { name = "sphinxcontrib-jquery" }, -] -wheels = [ - { url = "https://files.pythonhosted.org/packages/ea/46/00fda84467815c29951a9c91e3ae7503c409ddad04373e7cfc78daad4300/sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl", hash = "sha256:ec93d0856dc280cf3aee9a4c9807c60e027c7f7b461b77aeffed682e68f0e586", size = 2824721 }, -] - -[[distribution]] -name = "sphinx-sitemap" -version = "2.6.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/42/ed/96cc112b671e06df01c8306c25ce3331ccfece0d30235e32eb039afc8094/sphinx_sitemap-2.6.0.tar.gz", hash = "sha256:5e0c66b9f2e371ede80c659866a9eaad337d46ab02802f9c7e5f7bc5893c28d2", size = 6042 } -dependencies = [ - { name = "sphinx" }, -] -wheels = [ - { url = "https://files.pythonhosted.org/packages/94/d4/dffb4da380be24fd390d284634735d6fba560980014050e52569c04d215b/sphinx_sitemap-2.6.0-py3-none-any.whl", hash = "sha256:7478e417d141f99c9af27ccd635f44c03a471a08b20e778a0f9daef7ace1d30b", size = 5632 }, -] - [[distribution]] name = "sphinxcontrib-applehelp" version = "1.0.8" @@ -6500,18 +6471,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/c2/e9/74c4cda5b409af3222fda38f0774e616011bc935f639dbc0da5ca2d1be7d/sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl", hash = "sha256:393f04f112b4d2f53d93448d4bce35842f62b307ccdc549ec1585e950bc35e04", size = 99217 }, ] -[[distribution]] -name = "sphinxcontrib-jquery" -version = "4.1" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/de/f3/aa67467e051df70a6330fe7770894b3e4f09436dea6881ae0b4f3d87cad8/sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a", size = 122331 } -dependencies = [ - { name = "sphinx" }, -] -wheels = [ - { url = "https://files.pythonhosted.org/packages/76/85/749bd22d1a68db7291c89e2ebca53f4306c3f205853cf31e9de279034c3c/sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae", size = 121104 }, -] - [[distribution]] name = "sphinxcontrib-jsmath" version = "1.0.1"