mkdocs.yml

site_name: Rye
site_description: An Experimental Package Management Solution for Python
repo_name: astral-sh/rye
repo_url: https://github.com/astral-sh/rye
edit_uri: edit/main/docs/
copyright: Copyright © 2023 Armin Ronacher

nav:
  - Welcome: index.md
  - User Guide:
    - guide/index.md
    - Installation: guide/installation.md
    - Basics: guide/basics.md
    - Configuration: guide/config.md
    - Python Project: guide/pyproject.md
    - Syncing and Locking: guide/sync.md
    - Shims: guide/shims.md
    - Building and Publishing: guide/publish.md
    - Rust Modules: guide/rust.md
    - Dependency Sources: guide/sources.md
    - Dependencies: guide/deps.md
    - Workspaces: guide/workspaces.md
    - Virtual Projects: guide/virtual.md
    - Docker: guide/docker.md
    - Commands:
      - Overview: guide/commands/index.md
      - add: guide/commands/add.md
      - build: guide/commands/build.md
      - config: guide/commands/config.md
      - fetch: guide/commands/fetch.md
      - fmt: guide/commands/fmt.md
      - init: guide/commands/init.md
      - install: guide/commands/install.md
      - lock: guide/commands/lock.md
      - lint: guide/commands/lint.md
      - make-req: guide/commands/make-req.md
      - pin: guide/commands/pin.md
      - publish: guide/commands/publish.md
      - remove: guide/commands/remove.md
      - run: guide/commands/run.md
      - show: guide/commands/show.md
      - sync: guide/commands/sync.md
      - test: guide/commands/test.md
      - toolchain:
        - Overview: guide/commands/toolchain/index.md
        - fetch: guide/commands/toolchain/fetch.md
        - list: guide/commands/toolchain/list.md
        - register: guide/commands/toolchain/register.md
        - remove: guide/commands/toolchain/remove.md
      - tools:
        - Overview: guide/commands/tools/index.md
        - install: guide/commands/tools/install.md
        - uninstall: guide/commands/tools/uninstall.md
        - list: guide/commands/tools/list.md
      - self:
        - Overview: guide/commands/self/index.md
        - completion: guide/commands/self/completion.md
        - update: guide/commands/self/update.md
        - uninstall: guide/commands/self/uninstall.md
      - uninstall: guide/commands/uninstall.md
      - version: guide/commands/version.md
    - Toolchains:
      - guide/toolchains/index.md
      - Portable CPython: guide/toolchains/cpython.md
      - PyPy: guide/toolchains/pypy.md
    - Tools: guide/tools.md
    - FAQ: guide/faq.md
  - Community: community.md
  - Changelog: changelog.md
  - Philosophy: philosophy.md

theme:
  name: material
  custom_dir: docs/.overrides
  features:
    - navigation.instant
    - navigation.tracking
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.action.edit
    - toc.integrate
    - toc.follow
    - navigation.path
    - navigation.top
    - navigation.tabs
    - navigation.footer
  font:
    text: Inter
    monospace: Fira Mono
  favicon: static/favicon.svg
  logo: static/logo.svg

  # This is a bit of a hack.  We don't actually want this toggle at all,
  # it's all based on media queries.  But to abuse the mkdocs theme it
  # still uses the toggles to trigger all the default logic.  We will
  # then hide this selector though with CSS.  The auto updating then
  # happens in palette.html with JavaScript.
  palette:
    scheme: default
    primary: custom
    accent: custom

markdown_extensions:
  - attr_list
  - admonition
  - def_list
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - mdx_gh_links:
      user: astral-sh
      repo: rye
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
  - search
  - mkdocs-simple-hooks:
      hooks:
        on_post_build: "docs.hooks:copy_get"
  - mkdocs-version-annotations:
      version_added_title: 'new in **\1**'
      version_changed_title: 'changed in **\1**'
      version_removed_title: 'removed in **\1**'
  - include-markdown:
      preserve_includer_indent: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mitsuhiko
      name: Follow @mitsuhiko on GitHub
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/@mitsuhiko
      name: Follow @mitsuhiko on Twitter
    - icon: material/alpha-b-box
      link: https://bsky.app/profile/mitsuhiko.at
      name: Follow @mitsuhiko.at on Bluesky
    - icon: fontawesome/brands/discord
      link: https://discord.gg/drbkcdtSbg
      name: Discuss Rye on Discord

extra_css:
  - static/extra.css