From 691b948ad02a20e507d5059707f8cde51a94a703 Mon Sep 17 00:00:00 2001 From: Adeeb Shihadeh Date: Sun, 28 Jul 2024 16:07:39 -0700 Subject: [PATCH] docs: readthedocs theme (#33116) * docs: read the docs theme * nav depth --- .github/workflows/docs.yaml | 2 +- docs/how-to/connect-to-comma.md | 4 ++-- docs/how-to/turn-the-speed-blue.md | 4 ++-- mkdocs.yml | 10 +++------- pyproject.toml | 1 - uv.lock | 30 ------------------------------ 6 files changed, 8 insertions(+), 43 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 33f61173f..26b60ffec 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -29,7 +29,7 @@ jobs: - name: Build docs run: | # TODO: can we install just the "docs" dependency group without the normal deps? - pip install mkdocs mkdocs-terminal + pip install mkdocs mkdocs build # Push to docs.comma.ai diff --git a/docs/how-to/connect-to-comma.md b/docs/how-to/connect-to-comma.md index 53460ac99..d9c0c701c 100644 --- a/docs/how-to/connect-to-comma.md +++ b/docs/how-to/connect-to-comma.md @@ -51,14 +51,14 @@ Host ssh.comma.ai IdentityFile ~/.ssh/my_github_key ``` -## One-off connection +### One-off connection ``` ssh -i ~/.ssh/my_github_key -o ProxyCommand="ssh -i ~/.ssh/my_github_key -W %h:%p -p %p %h@ssh.comma.ai" comma@ffffffffffffffff ``` (Replace `ffffffffffffffff` with your dongle_id) -## ssh.comma.ai host key fingerprint +### ssh.comma.ai host key fingerprint ``` Host key fingerprint is SHA256:X22GOmfjGb9J04IA2+egtdaJ7vW9Fbtmpz9/x8/W1X4 diff --git a/docs/how-to/turn-the-speed-blue.md b/docs/how-to/turn-the-speed-blue.md index f76e9e489..643023fdf 100644 --- a/docs/how-to/turn-the-speed-blue.md +++ b/docs/how-to/turn-the-speed-blue.md @@ -86,13 +86,13 @@ git commit -m "Make the speed blue." git push --set-upstream origin master ``` -### 6. Run your fork on device in your car! +## 6. Run your fork on device in your car! Uninstall openpilot from your device through the settings. Then, enter the URL for your very own installer: ``` installer.comma.ai//master ``` -### 7. Admire your work IRL +## 7. Admire your work IRL ![](https://blog.comma.ai/img/c3_blue_ui.jpg) diff --git a/mkdocs.yml b/mkdocs.yml index 3eb02aac8..b9a901c4d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,13 +6,9 @@ strict: true docs_dir: docs site_dir: docs_site/ -#plugins: -# - commonmark - theme: - name: terminal - features: - - navigation.side.toc.hide + name: readthedocs + navigation_depth: 3 nav: - Getting Started: @@ -27,7 +23,7 @@ nav: - Contributing: - Roadmap: contributing/roadmap.md #- Architecture: contributing/architecture.md - - Contributing →: https://github.com/commaai/openpilot/blob/master/docs/CONTRIBUTING.md + - Contributing Guide →: https://github.com/commaai/openpilot/blob/master/docs/CONTRIBUTING.md - Links: - Blog →: https://blog.comma.ai - Bounties →: https://comma.ai/bounties diff --git a/pyproject.toml b/pyproject.toml index 456e8a8cd..86eb08fa1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -69,7 +69,6 @@ docs = [ "Jinja2", "natsort", "mkdocs", - "mkdocs-terminal", ] testing = [ diff --git a/uv.lock b/uv.lock index 980797805..a08ad9c4b 100644 --- a/uv.lock +++ b/uv.lock @@ -1135,22 +1135,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/42/7a/5ed794942ace9d00bb77a8036c64c999cda6ebaab57e9b8a6ec1aa5fc900/mkdocs-1.4.3-py3-none-any.whl", hash = "sha256:6ee46d309bda331aac915cd24aab882c179a933bd9e77b80ce7d2eaaa3f689dd", size = 3654464 }, ] -[[distribution]] -name = "mkdocs-terminal" -version = "4.4.0" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "jinja2" }, - { name = "markdown" }, - { name = "mkdocs" }, - { name = "pygments" }, - { name = "pymdown-extensions" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/b3/a4/afa8826c3d6971f3e93cb3669936b25579314fef2a4d648fe72729c9675f/mkdocs_terminal-4.4.0.tar.gz", hash = "sha256:d72b87b3d0edf470695811cb56c440a43b0387212590a5dfb2f26861c6e518d7", size = 619482 } -wheels = [ - { url = "https://files.pythonhosted.org/packages/93/65/7973dfe5ae03dd83a5a4e203b542ebacb16fd0c796e3f93f3cb98c3ffcc2/mkdocs_terminal-4.4.0-py3-none-any.whl", hash = "sha256:b2c94dc651c840e9762a1040d39371a31cc7482f7768e619e317419ebae4e40e", size = 641788 }, -] - [[distribution]] name = "mouseinfo" version = "0.1.3" @@ -1461,7 +1445,6 @@ dev = [ docs = [ { name = "jinja2" }, { name = "mkdocs" }, - { name = "mkdocs-terminal" }, { name = "natsort" }, ] testing = [ @@ -1899,19 +1882,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/4c/31/85a58625edc0b6967fe0904c9d89d019bcece3f3e3bf775b9151a8cf9d0d/pylibsrtp-0.10.0-cp38-abi3-win_amd64.whl", hash = "sha256:cd965d4b0e9a77b362526cab119f4d9ce39b83f1f20f46c6af8e694b86fa19a7", size = 1448840 }, ] -[[distribution]] -name = "pymdown-extensions" -version = "10.4" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "markdown" }, - { name = "pyyaml" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/85/71/5f48080bde77b07ca1eba6d7cb5c5598ac6c8f2a399846159b3c8b45e171/pymdown_extensions-10.4.tar.gz", hash = "sha256:bc46f11749ecd4d6b71cf62396104b4a200bad3498cb0f5dad1b8502fe461a35", size = 785151 } -wheels = [ - { url = "https://files.pythonhosted.org/packages/98/2d/2929de81618c7213176899dd6372d6ec9c8f24337841dd74634fb69864ae/pymdown_extensions-10.4-py3-none-any.whl", hash = "sha256:cfc28d6a09d19448bcbf8eee3ce098c7d17ff99f7bd3069db4819af181212037", size = 240838 }, -] - [[distribution]] name = "pymonctl" version = "0.92"