feat(docs): docstrings to mkdocs

Author: simonprovost

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.9"
+
+python:
+  install:
+    - requirements: requirements-dev.txt
+
+# Build documentation with Mkdocs
+mkdocs:
+   configuration: mkdocs.yml
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

build_docs.sh

@@ -0,0 +1,18 @@
+mkdocs.yml#!/bin/bash
+set -e
+
+if ! command -v uv &> /dev/null
+then
+    echo "UV is not installed. Please follow the documentation on the contributing page to install UV."
+    exit 1
+fi
+
+cd "$(dirname "$0")"
+
+uv venv
+uv sync
+
+uv run mkdocs build --strict
+
+echo "Documentation built successfully in the 'site' directory."
+echo "To preview, run: uv run mkdocs serve"

docs/.markdownlint.yml

@@ -0,0 +1,12 @@
+"default": true
+"MD002": false # First heading should be a top level heading
+"MD007": # Unordered list indentation
+  indent: 4
+"MD009": false # Trailing spaces
+"MD013": false # Line length
+"MD025": false # Multiple top level headings in the same document
+"MD026": false # Trailing punctuation in heading
+"MD033": false # Inline HTML
+"MD041": false # First line in file should be a top level heading
+"MD045": false # OK not to have a description for an image
+"MD046": false #  Code block style [Expected: fenced; Actual: indented]

docs/API/cli/stack_cli.md

@@ -0,0 +1,10 @@
+# StackCLI
+
+!!! note "Scope"
+    This page documents the **programmatic** CLI class — handy if you embed the CLI or generate help programmatically.
+    For end-user command help, see the **CLI** section of the docs.
+
+::: MCPStack.cli.StackCLI
+    options:
+      show_root_heading: true
+      show_source: true

docs/API/mcp_config_generators/claude.md

@@ -0,0 +1,6 @@
+# Claude (ClaudeDesktop) Config Generator
+
+::: MCPStack.core.mcp_config_generator.mcp_config_generators.claude_mcp_config.ClaudeConfigGenerator
+    options:
+      show_root_heading: true
+      show_source: true

docs/API/mcp_config_generators/fastmcp.md

@@ -0,0 +1,6 @@
+# FastMCP Config Generator
+
+::: MCPStack.core.mcp_config_generator.mcp_config_generators.fast_mcp_config.FastMCPConfigGenerator
+    options:
+      show_root_heading: true
+      show_source: true

docs/API/mcp_config_generators/registry.md

@@ -0,0 +1,6 @@
+# MCP Config Generators — Registry
+
+::: MCPStack.core.mcp_config_generator.registry
+    options:
+      show_root_heading: true
+      show_source: true

docs/API/mcp_config_generators/universal.md

@@ -0,0 +1,6 @@
+# Universal Config Generator
+
+::: MCPStack.core.mcp_config_generator.mcp_config_generators.universal_mcp_config.UniversalConfigGenerator
+    options:
+      show_root_heading: true
+      show_source: true

docs/API/mcpstackcore.md

@@ -0,0 +1,6 @@
+# MCPStackCore
+
+::: MCPStack.stack.MCPStackCore
+    options:
+      show_root_heading: true
+      show_source: true

docs/API/presets/base.md

@@ -0,0 +1,6 @@
+# Preset Base
+
+::: MCPStack.core.preset.base.Preset
+    options:
+      show_root_heading: true
+      show_source: true