[Core] SkyPilot Client-Server Architecture

.pre-commit-config.yaml

@@ -44,6 +44,7 @@ repos:
             - "sky/benchmark|sky/callbacks|sky/skylet/providers/azure|sky/resources.py|sky/backends/monkey_patches"
         pass_filenames: false
         additional_dependencies:
+            - types-aiofiles
             - types-PyYAML
             - types-requests<2.31  # Match the condition in requirements.txt
             - types-setuptools

docs/build.sh

@@ -20,16 +20,37 @@ fi
 
 rm -rf build docs
 
-# MacOS and GNU `script` have different usages
-if [ "$(uname -s)" = "Linux" ]; then
-  script -q /tmp/build_docs.txt -c "make html"
+# Add command line argument parsing
+AUTO_BUILD=false
+while [[ "$#" -gt 0 ]]; do
+    case $1 in
+        --watch|-w) AUTO_BUILD=true ;;
+        --port|-p) PORT=$2; shift ;;
+        *) echo "Unknown parameter: $1"; exit 1 ;;
+    esac
+    shift
+done
+
+if [ "$AUTO_BUILD" = true ]; then
+    # Use sphinx-autobuild for automatic rebuilding
+    # Ignore gallery directory to prevent unnecessary rebuilds
+    sphinx-autobuild source build/html \
+        --ignore "*.md" \
+        --port $PORT
 else
-  # Assume MacOS (uname -s = Darwin)
-  script -q /tmp/build_docs.txt bash -c "make html"
-fi
+    rm -rf build docs
 
-# Check if the output contains "ERROR:" or "WARNING:"
-if grep -q -E "ERROR:|WARNING:" /tmp/build_docs.txt; then
-  echo "Errors or warnings detected, exiting..."
-  exit 1
+    # MacOS and GNU `script` have different usages
+    if [ "$(uname -s)" = "Linux" ]; then
+        script -q /tmp/build_docs.txt -c "make html"
+    else
+        # Assume MacOS (uname -s = Darwin)
+        script -q /tmp/build_docs.txt bash -c "make html"
+    fi
+
+    # Check if the output contains "ERROR:" or "WARNING:"
+    if grep -q -E "ERROR:|WARNING:" /tmp/build_docs.txt; then
+        echo "Errors or warnings detected, exiting..."
+        exit 1
+    fi
 fi

docs/requirements-docs.txt

@@ -6,6 +6,7 @@ sphinx-design==0.5.0
 pydata-sphinx-theme==0.14.4
 Pygments==2.16.1
 myst-parser==2.0.0
+sphinx-autobuild==2021.3.14
 
 sphinx-autodoc-typehints==1.25.2
 sphinx-book-theme==1.1.0

docs/source/_static/custom.js

@@ -27,6 +27,7 @@ document.addEventListener('DOMContentLoaded', () => {
     // New items:
     const newItems = [
         { selector: '.toctree-l1 > a', text: 'Many Parallel Jobs' },
+        { selector: '.toctree-l1 > a', text: 'SkyPilot API Server' },
         { selector: '.toctree-l1 > a', text: 'Admin Policies' },
         { selector: '.toctree-l2 > a', text: 'Multiple Kubernetes Clusters' },
         { selector: '.toctree-l2 > a', text: 'HTTPS Encryption' },

docs/source/cloud-setup/policy.rst

@@ -102,10 +102,10 @@ a request should be rejected, the policy should raise an exception.
 
 The ``sky.Config`` and ``sky.RequestOptions`` classes are defined as follows:
 
-.. literalinclude:: ../../../sky/skypilot_config.py
+.. literalinclude:: ../../../sky/utils/config_utils.py
     :language: python
     :pyobject: Config
-    :caption: `Config Class <https://github.com/skypilot-org/skypilot/blob/master/sky/skypilot_config.py>`_
+    :caption: `Config Class <https://github.com/skypilot-org/skypilot/blob/master/sky/utils/config_utils.py>`_
 
 
 .. literalinclude:: ../../../sky/admin_policy.py

docs/source/conf.py

@@ -56,7 +56,13 @@
 main_doc = 'index'
 
 autosummary_generate = True
-napolean_use_rtype = False
+# Disable automatic type hints to let Napoleon handle them
+napoleon_use_rtype = False
+# Napoleon settings
+napoleon_custom_sections = [
+    ('Request Returns', 'params_style'),
+    ('Request Raises', 'params_style'),
+]
 
 # -- Options for autodoc
 

docs/source/docs/index.rst

@@ -193,6 +193,7 @@ Read the research:
    :maxdepth: 1
    :caption: User Guides
 
+   ../reference/api-server/api-server
    Secrets and Environment Variables <../running-jobs/environment-variables>
    Docker Containers <../examples/docker-containers>
    ../examples/ports