Create documentation.

Author: darmendariz

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Deploy docs
+        run: uv run mkdocs gh-deploy --force

impulse/parsing/replay_parser.py

@@ -70,7 +70,7 @@ def __init__(self, global_features: List[str], player_features: List[str], fps:
         self.fps = fps
 
     @classmethod
-    def from_preset(cls, preset_name: str, fps: float = ParsingConfig.DEFAULT_FPS):
+    def from_preset(cls, preset_name: str, fps: float = ParsingConfig.DEFAULT_FPS) -> "ReplayParser":
         """
         Create parser from a feature preset.
         

mkdocs.yml

@@ -0,0 +1,86 @@
+site_name: Impulse
+site_description: A Python library for collecting, parsing, and processing Rocket League replay files for machine learning.
+site_url: https://darmendariz.github.io/impulse
+repo_url: https://github.com/darmendariz/impulse
+repo_name: darmendariz/impulse
+
+theme:
+  name: material
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - search.highlight
+    - search.suggest
+    - content.code.copy
+    - content.code.annotate
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            docstring_style: google
+            show_source: true
+            show_root_heading: true
+            show_root_full_path: false
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            members_order: source
+            separate_signature: true
+            show_signature_annotations: true
+            merge_init_into_class: true
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.snippets
+  - attr_list
+  - md_in_html
+  - toc:
+      permalink: true
+
+nav:
+  - Home: index.md
+  - Getting Started:
+    - Installation: getting-started/installation.md
+    - Quick Start: getting-started/quickstart.md
+  - Collection:
+    - Overview: collection/overview.md
+    - Downloading Replays: collection/downloading.md
+    - Storage Backends: collection/storage.md
+    - RLCS Seasons: collection/rlcs.md
+    - API Reference: collection/api-reference.md
+  - Parsing:
+    - Overview: parsing/overview.md
+    - Feature Extraction: parsing/features.md
+    - Output Formats: parsing/output-formats.md
+    - API Reference: parsing/api-reference.md
+  - Configuration:
+    - Overview: configuration/index.md
+  - Reference:
+    - Database: reference/database.md
+    - Changelog: reference/changelog.md

pyproject.toml

@@ -21,7 +21,12 @@ dependencies = [
 
 [dependency-groups]
 dev = [
+    "mkdocs-gen-files>=0.6.0",
+    "mkdocs-literate-nav>=0.6.2",
+    "mkdocs-material>=9.7.2",
+    "mkdocstrings[python]>=1.0.3",
     "pytest-cov>=7.0.0",
     "pytest-mock>=3.15.1",
     "responses>=0.25.8",
+    "ruff>=0.15.2",
 ]