Add docs readme.

Author: alexmillane

.github/workflows/gh-pages.yml

@@ -17,28 +17,18 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-      # - name: Install git LFS (and tools needed by hooks)
-      #   run: |
-      #     apt-get update
-      #     apt-get install -y --no-install-recommends git git-lfs clang-format ca-certificates make
-      #     git --version
-      #     git lfs version
-
-      # Checkout Code
       - name: Checkout Code
         uses: actions/checkout@v4
         with:
           clean: true
           fetch-depth: 0
           fetch-tags: true
-      # Build docs
       - name: Build docs
         run: |
           cd docs
           pip3 install -r requirements.txt
           make SPHINXOPTS=-W multi-docs
           touch ./_build/.nojekyll
-      # Deploy to gh-pages
       - name: Deploy to gh-pages
         uses: peaceiris/actions-gh-pages@v3
         with:

.github/workflows/premerge.yml

@@ -109,7 +109,7 @@ jobs:
   ## --------------------------------------------------------
   build_docs:
     name: Build docs
-    # needs: [lint_precommit] # ADD BACK IN BEFORE MERGE
+    needs: [lint_precommit]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code

docs/README.md

@@ -0,0 +1,47 @@
+# `nvblox` Dox - Developer Guide
+
+To build the `nvblox` docs locally follow the following instructions.
+
+Enter the `nvblox` docker.
+
+```
+./docker/run_docker.sh
+```
+
+Deactivate the `nvblox` venv
+
+```
+deactivate
+```
+
+Install a `git-lfs` for downloading images used in the docs.
+
+```
+sudo apt-get update && sudo apt-get install git-lfs
+```
+
+Create a `venv` and install the dependencies
+
+```
+python3 -m venv venv_docs
+source venv_docs/bin/activate
+cd ./docs
+python3 -m pip install -r requirements.txt
+```
+
+To make the current version of docs
+
+```
+make html
+```
+
+To view the docs, navigate to `nvblox/docs/_build/current/html/index.html`, and double-click.
+
+To make the multi version docs. Note that this will only build docs for the set branches, such
+as release, main etc. Only docs committed to these branches will be reflected.
+
+```
+make multi-docs
+```
+
+To view the multi version docs, navigate to `nvblox/docs/_build/index.html`, and double-click.