mirror of
https://github.com/open-jarvis/OpenJarvis.git
synced 2026-07-30 19:02:16 +00:00
Jon Saad-FalconandGitHub
c8f3c01407
feat: add auto-generated API reference via gen-files + literate-nav
171 lines
4.8 KiB
YAML
171 lines
4.8 KiB
YAML
site_name: OpenJarvis
|
|
site_url: https://hazyresearch.stanford.edu/OpenJarvis/
|
|
site_description: Programming abstractions for on-device AI
|
|
site_author: OpenJarvis Contributors
|
|
repo_url: https://github.com/HazyResearch/OpenJarvis
|
|
repo_name: HazyResearch/OpenJarvis
|
|
edit_uri: edit/main/docs/
|
|
|
|
copyright: Copyright © 2026 OpenJarvis Contributors
|
|
|
|
theme:
|
|
name: material
|
|
language: en
|
|
font:
|
|
text: Merriweather
|
|
code: JetBrains Mono
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.top
|
|
- navigation.indexes
|
|
- navigation.footer
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.tabs.link
|
|
- toc.follow
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: custom
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: custom
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
plugins:
|
|
- search
|
|
- gen-files:
|
|
scripts:
|
|
- docs/gen_ref_pages.py
|
|
- literate-nav:
|
|
nav_file: SUMMARY.md
|
|
- mkdocstrings:
|
|
default_handler: python
|
|
handlers:
|
|
python:
|
|
paths: [src]
|
|
options:
|
|
show_source: true
|
|
show_root_heading: true
|
|
show_root_full_path: false
|
|
show_category_heading: true
|
|
show_symbol_type_heading: true
|
|
show_symbol_type_toc: true
|
|
members_order: source
|
|
docstring_style: numpy
|
|
docstring_section_style: spacy
|
|
merge_init_into_class: true
|
|
show_signature_annotations: true
|
|
separate_signature: true
|
|
signature_crossrefs: true
|
|
show_if_no_docstring: false
|
|
inherited_members: false
|
|
filters:
|
|
- "!^_"
|
|
- "^__init__$"
|
|
- "^__all__$"
|
|
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 3
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets:
|
|
auto_append:
|
|
- docs/includes/abbreviations.md
|
|
check_paths: false
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/HazyResearch/OpenJarvis
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Downloads: downloads.md
|
|
- Getting Started:
|
|
- Installation: getting-started/installation.md
|
|
- Quick Start: getting-started/quickstart.md
|
|
- Configuration: getting-started/configuration.md
|
|
- User Guide:
|
|
- CLI Reference: user-guide/cli.md
|
|
- Python SDK: user-guide/python-sdk.md
|
|
- Agents: user-guide/agents.md
|
|
- Memory: user-guide/memory.md
|
|
- Tools: user-guide/tools.md
|
|
- Scheduler: user-guide/scheduler.md
|
|
- Telemetry & Traces: user-guide/telemetry.md
|
|
- Benchmarks: user-guide/benchmarks.md
|
|
- Evaluations: user-guide/evaluations.md
|
|
- Security: user-guide/security.md
|
|
- Channels: user-guide/channels.md
|
|
- Architecture:
|
|
- Overview: architecture/overview.md
|
|
- Intelligence: architecture/intelligence.md
|
|
- Inference Engine: architecture/engine.md
|
|
- Agentic Logic: architecture/agents.md
|
|
- Memory & Storage: architecture/memory.md
|
|
- Learning & Traces: architecture/learning.md
|
|
- Query Flow: architecture/query-flow.md
|
|
- Design Principles: architecture/design-principles.md
|
|
- Security: architecture/security.md
|
|
- Channels: architecture/channels.md
|
|
- API Reference: api-reference/
|
|
- Deployment:
|
|
- Docker: deployment/docker.md
|
|
- systemd (Linux): deployment/systemd.md
|
|
- launchd (macOS): deployment/launchd.md
|
|
- API Server: deployment/api-server.md
|
|
- Development:
|
|
- Contributing: development/contributing.md
|
|
- Extending OpenJarvis: development/extending.md
|
|
- Roadmap: development/roadmap.md
|
|
- Changelog: development/changelog.md
|