publish new docs (commaai#32922)

* push new docs * drop the new, just docs * cleanup
andiradulescu · Jul 8, 2024 · 241fb90 · 241fb90
1 parent 4445fa3
commit 241fb90
Show file tree

Hide file tree

Showing 12 changed files with 312 additions and 136 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -15,56 +15,51 @@ concurrency:
   group: docs-tests-ci-run-${{ inputs.run_number }}-${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && github.run_id || github.head_ref || github.ref }}-${{ github.workflow }}-${{ github.event_name }}
   cancel-in-progress: true
 
-env:
-  BASE_IMAGE: openpilot-base
-
-  BUILD: selfdrive/test/docker_build.sh base
-
-  RUN: docker run --shm-size 1G -v $GITHUB_WORKSPACE:/tmp/openpilot -w /tmp/openpilot -e FILEREADER_CACHE=1 -e PYTHONPATH=/tmp/openpilot -e NUM_JOBS -e JOB_ID -e GITHUB_ACTION -e GITHUB_REF -e GITHUB_HEAD_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_RUN_ID -v $GITHUB_WORKSPACE/.ci_cache/scons_cache:/tmp/scons_cache -v $GITHUB_WORKSPACE/.ci_cache/comma_download_cache:/tmp/comma_download_cache -v $GITHUB_WORKSPACE/.ci_cache/openpilot_cache:/tmp/openpilot_cache $BASE_IMAGE /bin/bash -c
-
 jobs:
   docs:
     name: build docs
     runs-on: ubuntu-latest
-    timeout-minutes: 45
-    if: false  # TODO: replace this with the new docs
+    timeout-minutes: 1
     steps:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - uses: ./.github/workflows/setup-with-retry
-    - name: Build openpilot
-      run: |
-        ${{ env.RUN }} "scons -j$(nproc)"
+
+    # Build
     - name: Build docs
       run: |
-        ${{ env.RUN }} "apt update && apt install -y doxygen && cd docs && make -j$(nproc) html"
+        # TODO: can we install just the "docs" dependency group without the normal deps?
+        pip install mkdocs mkdocs-terminal
+        cd docs
+        mkdocs build
 
+    # Push to docs.comma.ai
     - uses: actions/checkout@v4
-      if: github.ref == 'refs/heads/master' && github.repository == 'commaai/openpilot'
+      #if: github.ref == 'refs/heads/master' && github.repository == 'commaai/openpilot'
       with:
         path: openpilot-docs
         ssh-key: ${{ secrets.OPENPILOT_DOCS_KEY }}
         repository: commaai/openpilot-docs
     - name: Push
-      if: github.ref == 'refs/heads/master' && github.repository == 'commaai/openpilot'
+      #if: github.ref == 'refs/heads/master' && github.repository == 'commaai/openpilot'
       run: |
         set -x
 
         source release/identity.sh
 
         cd openpilot-docs
-
         git checkout --orphan tmp
         git rm -rf .
 
-        cp -r ../build/docs/html/ docs/
-        cp -r ../docs/README.md .
-        touch docs/.nojekyll
-        echo -n docs.comma.ai > docs/CNAME
-        git add -f .
+        # copy over docs
+        cp -r ../docs/site/ site/
 
+        # GitHub pages config
+        touch site/.nojekyll
+        echo -n docs.comma.ai > site/CNAME
+
+        git add -f .
         git commit -m "build docs"
 
         # docs live in different repo to not bloat openpilot's full clone size
-        git push -f origin tmp:gh-pages
+        git push -f origin tmp:gh-pages2
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+/site/
diff --git a/docs/README.md b/docs/README.md
@@ -1,3 +1,22 @@
-# openpilot-docs
+# openpilot docs
 
-These docs are autogenerated from [this folder](https://github.com/commaai/openpilot/tree/master/docs) in the main openpilot repository.
+This is the source for [docs.comma.ai](https://docs.comma.ai).
+The site is updated on pushes to master by this [workflow](../.github/workflows/docs.yaml).
+
+## development
+```
+# install the docs dependencies
+pip install .[docs]
+
+cd docs/
+
+# for a development server
+mkdocs serve
+
+# build the site
+mkdocs build
+```
+
+References:
+* https://www.mkdocs.org/getting-started/
+* https://github.com/ntno/mkdocs-terminal
diff --git a/docs/new/docs/car-porting/brand-port.md → docs/docs/car-porting/brand-port.md b/docs/new/docs/car-porting/brand-port.md → docs/docs/car-porting/brand-port.md
diff --git a/docs/new/docs/car-porting/model-port.md → docs/docs/car-porting/model-port.md b/docs/new/docs/car-porting/model-port.md → docs/docs/car-porting/model-port.md
diff --git a/...ew/docs/car-porting/what-is-a-car-port.md → docs/docs/car-porting/what-is-a-car-port.md b/...ew/docs/car-porting/what-is-a-car-port.md → docs/docs/car-porting/what-is-a-car-port.md
diff --git a/...docs/getting-started/what-is-openpilot.md → ...docs/getting-started/what-is-openpilot.md b/...docs/getting-started/what-is-openpilot.md → ...docs/getting-started/what-is-openpilot.md
diff --git a/...new/docs/how-to/turning-the-speed-blue.md → docs/docs/how-to/turning-the-speed-blue.md b/...new/docs/how-to/turning-the-speed-blue.md → docs/docs/how-to/turning-the-speed-blue.md
diff --git a/docs/new/mkdocs.yml → docs/mkdocs.yml b/docs/new/mkdocs.yml → docs/mkdocs.yml
diff --git a/docs/new/README.md b/docs/new/README.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -66,6 +66,8 @@ dependencies = [
 [project.optional-dependencies]
 docs = [
   "Jinja2",
+  "mkdocs",
+  "mkdocs-terminal",
 ]
 
 testing = [

diff --git a/uv.lock b/uv.lock