OpenEnv/docs/mkdocs.yml

site_name: OpenEnv Documentation
site_description: Official documentation for the OpenEnv agentic execution framework
site_url: https://meta-pytorch.github.io/OpenEnv
repo_url: https://github.com/meta-pytorch/OpenEnv
repo_name: meta-pytorch/OpenEnv

docs_dir: .
site_dir: ../site

theme:
  name: material
  font:
    text: Inter
  logo: https://github.com/user-attachments/assets/2700a971-e5d6-4036-b03f-2f89c9791609
  palette:
    - scheme: slate
      primary: grey
      accent: blue grey
  features:
    - navigation.expand
    - navigation.top
    - toc.integrate
    - content.code.copy
    - navigation.instant

extra_css:
  - styles/theme.css

plugins:
  - search
  - include-markdown:
      rewrite_relative_urls: true
      opening_tag: "--8<--"
      closing_tag: ""
      directives:
        include-markdown: ""
  - mkdocstrings:
      handlers:
        python:
          paths:
            - ../src
          options:
            show_source: false
            members_order: source

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.superfences
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
      toc_depth: 1
  - pymdownx.blocks.admonition:
      types:
        - name: note
        - name: tip
        - name: important
        - name: warning
        - name: caution
  - meta

watch:
  - ../src/openenv/core
  - ../src/openenv/cli
  - ../src/openenv/auto

nav:
  - Get Started:
    - What is OpenEnv?: index.md
    - Quick Start: quickstart.md
    - Auto-Discovery API: auto-discovery.md
    - Building an Environment: environment-builder.md
    - Contributing Environments: contributing-envs.md
    - Customizing the Web UI: customizing-web-ui.md
  - Tutorials:
    - OpenEnv Tutorial: tutorials/openenv-tutorial.md
    - Wordle GRPO with TRL: tutorials/wordle-grpo.md
  - Environments: environments.md

  - API Reference:
    - Core: core.md
    - CLI: cli.md