mkdocs-user-docs.yml

site_name: PyPI Docs
docs_dir: user
site_dir: user-site
plugins:
  - search
  - macros:
      module_name: user/main
      j2_block_start_string: "<!--[[%"
      j2_block_end_string: "%]]-->"
      j2_variable_start_string: "<!--[["
      j2_variable_end_string: "]]-->"
markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify:
        !!python/object/apply:pymdownx.slugs.slugify { kwds: { case: lower } }
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink:
      repo_url_shorthand: true
      normalize_issue_symbols: true
      provider: github
      user: pypi
      repo: warehouse
theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.ico
  homepage: https://pypi.org
  features:
    - content.action.edit
  palette:
    - scheme: default
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/weather-night
        name: Switch to Dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/weather-sunny
        name: Switch to Light mode
extra_css:
  - stylesheets/extra.css
extra:
  homepage: https://pypi.org
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pypi
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/pypi
repo_url: https://github.com/pypi/warehouse
edit_uri: blob/main/docs/user/

nav:
  - "index.md"
  - "Organization Accounts":
      - "organization-accounts/index.md"
      - "organization-accounts/org-acc-faq.md"
      - "organization-accounts/roles-entities.md"
      - "Actions":
          - "organization-accounts/actions/billing-actions.md"
          - "organization-accounts/actions/org-actions.md"
          - "organization-accounts/actions/project-actions.md"
          - "organization-accounts/actions/team-actions.md"
      - "organization-accounts/pricing-and-payments.md"
  - "Trusted Publishers":
      - "trusted-publishers/index.md"
      - "trusted-publishers/adding-a-publisher.md"
      - "trusted-publishers/creating-a-project-through-oidc.md"
      - "trusted-publishers/using-a-publisher.md"
      - "trusted-publishers/security-model.md"
      - "trusted-publishers/troubleshooting.md"
      - "trusted-publishers/internals.md"
  - "Digital Attestations":
      - "attestations/index.md"
      - "attestations/producing-attestations.md"
      - "attestations/consuming-attestations.md"
      - "attestations/publish/v1.md"
      - "attestations/security-model.md"
  - "project_metadata.md"
  - "APIs and Datasets":
      - "api/index.md"
      - "api/index-api.md"
      - "api/json.md"
      - "api/upload.md"
      - "api/integrity.md"
      - "api/stats.md"
      - "api/bigquery.md"
      - "api/feeds.md"
      - "api/secrets.md"