Added docks system

.copier/answers.docs.yml

@@ -0,0 +1,5 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v1.0.2
+_src_path: https://git.spirirobotics.com/Spiri/template-docs.git
+author_name: Spiri Robotics
+project_name: spiri-sdk

.github/workflows/build-docs.yaml

@@ -0,0 +1,44 @@
+name: Build Docs
+
+on:
+  push:
+
+env:
+  REGISTRY: git.spirirobotics.com
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container: sphinxdoc/sphinx-latexpdf
+
+    steps:
+    - name: Install sphinx-rtd-theme
+      run: pip install sphinx-rtd-theme
+    - name: Install node so that custom actions work.
+      run : apt-get update && apt-get --yes install nodejs git
+
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+
+    - name: Build Docs
+      run: make html latexpdf
+      working-directory: docs  # assuming your documentation is in a 'docs' folder
+
+    - name: Save PDF Artifacts
+      run: mv docs/build/latex/*.pdf ${{ github.workspace }}/docs.pdf
+
+    - name: Compress HTML
+      run: tar -czvf docs_html.tar.gz -C docs/build/html .
+
+    - name: Upload Docs
+      uses: actions/upload-artifact@v3
+      with:
+        name: docs_html.tar.gz
+        path: docs_html.tar.gz
+
+    - name: Upload PDF
+      uses: actions/upload-artifact@v3
+      with:
+        name: docs.pdf
+        path: docs.pdf

.gitignore

@@ -1 +1 @@
-spiri-sdk-home
+docs/build/

README.md

@@ -12,7 +12,7 @@ Advanced users can also use the SDK as a docker image. It pairs well with
 integrate it with their existing linux workflows.
 
 ```bash
-distrobox create --image git.spirirobotics.com/spiri/spiri-sdk-desktop:main
+distrobox create --image git.spirirobotics.com/spiri/spiri-sdk-desktop:master
 distrobox enter spiri-sdk-desktop-main
 #You can optionally copy the standard SDK setup from /opt/spiri-sdk/user-home-skeleton/
 # cp -r /opt/spiri-sdk/user-home-skeleton/* ~/
@@ -20,6 +20,15 @@ cd /opt/spiri-sdk/PX4-Autopilot/
 make px4_sitl gazebo-classic #Start the simulator
 ```
 
+You can also run a full init system, and it's own docker container, using
+
+```bash
+distrobox create --root \
+  --image git.spirirobotics.com/spiri/spiri-sdk-desktop:master \
+  --init \
+  --unshare-all
+```
+
 # Building
 
 ```bash

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.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
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,11 @@
+If you have a correctly configured sphinx environment you can build this project
+using `make html latexpdf`.
+
+You can also use nektos/act to build this project in the same way our build does.
+```bash
+cd ../ #Make sure you're in the project root, you should have a hidden folder
+# named ./.github/workflows available.
+act --artifact-server-path ./doc-build
+```
+
+Your compiled doc project will now be in the ./doc-build folder.

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_static/custom.css

@@ -0,0 +1,34 @@
+.wy-side-nav-search {
+    background: #FFFFFF !important;
+}
+
+
+.wy-nav-side {
+    background-color: #FFFFFF !important;
+}
+
+
+/* Add borders and box-shadow */
+.wy-side-nav {
+    border: 1px solid #899CA3 !important;
+}
+
+.logo {
+    width: 100px !important;
+}
+
+.wy-menu-vertical a {
+    color: #899CA3 !important; /* Change to your desired color */
+}
+
+.document-title {
+    color: #000 !important; 
+    font-size: 24px !important;
+    text-transform: uppercase !important;
+}
+
+.icon-home {
+    font-weight: bold !important;
+    text-transform: uppercase !important;
+    color: #000 !important; 
+}

docs/source/conf.py

@@ -0,0 +1,65 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import sphinx_rtd_theme
+
+project = "spiri-sdk"
+copyright = "2024, Spiri Robotics"
+author = "Spiri Robotics"
+
+html_logo = "logos/SPIRI_STLockup_Mixed_RGB.png"  # For HTML output
+html_logo_width = '200px' 
+latex_logo = "logos/SPIRI_STLockup_Mixed_RGB.png"
+latex_logo_width = '5cm'
+
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+]
+
+
+numfig = True
+
+todo_include_todos = True
+todo_emit_warnings = True
+todo_link_only = True
+
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+html_static_path = ['_static']
+
+html_css_files = [
+    'custom.css',
+]
+
+
+html_theme_options = {
+    'collapse_navigation': True,
+    'sticky_navigation': True,
+    'navigation_depth': 4, #could be set to -1 if we want unlimited depth
+    'includehidden': True,
+    'titles_only': False
+}
+
+latex_engine = "xelatex"
+# Configure LaTeX options for PDF generation

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. spiri-sdk documentation master file, created by
+   sphinx-quickstart on Wed Feb 14 11:51:45 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to spiri-sdk's documentation!
+============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`