Update doc

ceylonai · Jan 24, 2025 · 6fbc7e8 · 6fbc7e8
1 parent 676c7b4
commit 6fbc7e8
Show file tree

Hide file tree

Showing 5 changed files with 141 additions and 0 deletions.
diff --git a/docs/.overrides/main.html b/docs/.overrides/main.html
@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+<html>
+<head>
+    {% if page and page.meta and page.meta.title %}
+    <title>{{ page.meta.title }}</title>
+    {% elif page and page.title and not page.is_homepage %}
+    <title>{{ page.title }} - {{ config.site_name }}</title>
+    {% else %}
+    <title>{{ config.site_name }}</title>
+    {% endif %}
+
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <!-- Your custom CSS -->
+    <link rel="stylesheet" href="{{ 'css/custom.css'|url }}">
+
+    <!-- Material theme CSS (if using material theme) -->
+    {% if config.theme.name == 'material' %}
+    <link rel="stylesheet" href="{{ 'assets/stylesheets/material.css'|url }}">
+    {% endif %}
+</head>
+<body>
+<header>
+    <nav>
+        <!-- Your custom navigation -->
+        <div class="nav-wrapper">
+            <a href="{{ nav.homepage.url|url }}" class="brand">{{ config.site_name }}</a>
+            <ul class="nav-links">
+                {% for nav_item in nav %}
+                <li {% if nav_item.active %}class="active" {% endif %}>
+                    <a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
+                </li>
+                {% endfor %}
+            </ul>
+        </div>
+    </nav>
+</header>
+
+<main>
+    <div class="content-wrapper">
+        {% block content %}
+        {{ page.content }}
+        {% endblock %}
+    </div>
+</main>
+
+<footer>
+    <!-- Your custom footer -->
+    <div class="footer-content">
+        <p>&copy; {{ config.copyright }}</p>
+    </div>
+</footer>
+
+<!-- MkDocs JavaScript -->
+{% for path in config.extra_javascript %}
+<script src="{{ path|url }}"></script>
+{% endfor %}
+</body>
+</html>
diff --git a/docs/.partials/index-header.html b/docs/.partials/index-header.html
@@ -0,0 +1,37 @@
+<!--
+  ~ Copyright 2024-Present, Syigen Ltd. and Syigen Private Limited. All rights reserved.
+  ~ Licensed under the Apache License, Version 2.0 (See LICENSE.md or http://www.apache.org/licenses/LICENSE-2.0).
+  ~
+  -->
+
+<div class="text-center">
+    <img class="index-header off-glb" src="./img/pydantic-ai-dark.svg#only-dark" alt="PydanticAI">
+</div>
+<div class="text-center">
+    <img class="index-header off-glb" src="./img/pydantic-ai-light.svg#only-light" alt="PydanticAI">
+</div>
+<p class="text-center">
+    <em>Agent Framework / shim to use Pydantic with LLMs</em>
+</p>
+<p class="text-center">
+    <a href="https://github.com/ceylonai/ceylon/actions/workflows/ci.yml?query=branch%3Amain">
+        <img src="https://github.com/ceylonai/ceylon/actions/workflows/ci.yml/badge.svg?event=push" alt="CI">
+    </a>
+    <a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/ceylonai/ceylon">
+        <img src="https://coverage-badge.samuelcolvin.workers.dev/ceylonai/ceylon.svg" alt="Coverage">
+    </a>
+    <a href="https://pypi.python.org/pypi/ceylon">
+        <img src="https://img.shields.io/pypi/v/ceylon.svg" alt="PyPI">
+    </a>
+    <a href="https://github.com/ceylonai/ceylon">
+        <img src="https://img.shields.io/pypi/pyversions/pydantic-ai.svg" alt="versions">
+    </a>
+    <a href="https://github.com/ceylonai/ceylon/blob/master/LICENSE">
+        <img src="https://img.shields.io/github/license/ceylonai/ceylon.svg" alt="license">
+    </a>
+</p>
+
+<p class="text-emphasis">
+    PydanticAI is a Python agent framework designed to make it less painful to
+    build production grade applications with Generative AI.
+</p>
diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/docs/img/logo.png b/docs/img/logo.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,50 @@
 site_name: "Ceylon: A Multi-Agent System (MAS)"
 site_url: "https://ceylon.ai"
+
+copyright: © SYIGEN LTD. 2023 to present
+extra:
+  # hide the "Made with Material for MkDocs" message
+  generator: false
 theme:
   name: "material"
+  #  custom_dir: docs/.overrides
+  palette:
+    - media: "(prefers-color-scheme)"
+      scheme: default
+      primary: purple
+      accent: pink
+      toggle:
+        icon: material/lightbulb
+        name: "Switch to light mode"
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: purple
+      accent: pink
+      toggle:
+        icon: material/lightbulb-outline
+        name: "Switch to dark mode"
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: dark-purple
+      accent: pink
+      toggle:
+        icon: material/lightbulb-auto-outline
+        name: "Switch to system preference"
+  features:
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.annotate
+    - content.code.copy
+    - content.code.select
+    - navigation.path
+    #    - navigation.expand
+    - navigation.indexes
+    - navigation.sections
+    - navigation.tracking
+    - toc.follow
+  #    - navigation.tabs  # don't use navbar tabs
+  logo: "img/logo.png"
+  favicon: "favicon.ico"
 
 use_directory_urls: false