add docs site

Author: jxtngx

.github/docs.yml

@@ -0,0 +1,30 @@
+name: Build Docs
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: cp README.md docs/index.md
+      - run: mkdocs gh-deploy --force

.pre-commit-config.yaml

@@ -7,7 +7,6 @@ repos:
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
-      - id: check-yaml
       - id: check-added-large-files
 
   - repo: https://github.com/PyCQA/isort

docs/index.md

@@ -0,0 +1,56 @@
+# Home
+
+A simple Python client for the [Lambda Cloud API](https://cloud.lambdalabs.com/api/v1/docs#overview--response-types-and-formats), built with [httpx](https://www.python-httpx.org/).
+
+> [!NOTE]
+> This library is not an official Lambda Labs project
+
+> [!NOTE]
+> This library is developed alongside GitHub Copilot and various AI models by OpenAI and Anthropic
+
+## Installation
+
+### Installation via PyPI
+
+```bash
+pip install lambda-cloud-python
+```
+
+### Installation from source
+
+```bash
+git clone https://github.com/jxtngx/lambda-cloud-python.git
+cd lambda-cloud-python
+pip install -e .
+```
+
+## Usage
+
+> [!NOTE]
+> see [docs](./docs/) for more examples
+
+The Lambda Cloud Python client provides the following functionality:
+
+### Instances
+- `instances.list()` - Get all instances for the account
+- `instances.get(instance_id)` - Get details for a specific instance
+- `instances.update(instance_id, ...)` - Update details of a specific instance
+- `instances.launch(...)` - Launch one or more new instances
+- `instances.restart(instance_ids)` - Start one or more instances
+- `instances.terminate(instance_ids)` - Terminate one or more instances
+
+### Instance Types
+- `instance_types.list()` - Get available instance types and their specifications
+
+### SSH Keys
+- `ssh_keys.list()` - Get all SSH keys for the account
+- `ssh_keys.add(name, public_key)` - Add a new SSH key
+- `ssh_keys.delete(name)` - Delete an SSH key
+
+### File Systems
+- `file_systems.list()` - Get all file systems for the account
+- `file_systems.create(...)` - Create a new file system
+- `file_systems.delete(name)` - Delete a file system
+
+### Images
+- `images.list()` - List available machine images

mkdocs.yml

@@ -0,0 +1,74 @@
+site_name: Lambda Cloud Python
+site_author: Justin Goheen
+repo_url: https://github.com/jxtngx/lambda-cloud-python
+repo_name: Lambda Cloud Python
+
+theme:
+  name: material
+  icon:
+    repo: fontawesome/brands/github
+  font:
+    text: Roboto
+    code: Roboto Mono
+  features:
+    - navigation.sections
+    - navigation.path
+    - navigation.top
+    - content.code.copy
+  palette:
+    # Palette toggle for automatic mode
+    - scheme: default
+      primary: black
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: black
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+plugins:
+  - search
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          paths: [src]
+          options:
+            docstring_style: google
+            show_source: false
+            line_length: 120
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/jxtngx
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/in/jxtngx/
+
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+extra_javascript:
+  - javascripts/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js