zensical.yml

site_name: Beancount Documentation
site_description: Auto-generated markdown version
site_url: "https://beancount.github.io/docs/"
strict: false
use_directory_urls: true

repo_url: https://github.com/beancount/docs
repo_name: beancount/docs

theme:
  name: "material"
  variant: "classic"
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme)"
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-auto
        name: "Switch to light mode"
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: "Switch to dark mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        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.indexes
    - navigation.sections
    - navigation.tracking
    - toc.follow
    - announce.dismiss
  logo: "img/logo.png"
  favicon: "img/logo.png"

nav:
  - Index: index.md
  - Outline:
    - Documentation for Users:
      - Command Line Accounting in Context: command_line_accounting_in_context.md
      - The Double Entry Counting Method: the_double_entry_counting_method.md
      - Installing Beancount: installing_beancount.md
      - Running Beancount and Generating Reports: running_beancount_and_generating_reports.md
      - Getting Started with Beancount: getting_started_with_beancount.md
      - Beancount Language Syntax: beancount_language_syntax.md
      - Beancount Options Reference: beancount_options_reference.md
      - Precision Tolerances: precision_tolerances.md
      - Beancount Query Language: beancount_query_language.md
      - Beancount Cheat Sheet: beancount_cheat_sheet.md
      - How Inventories Work: how_inventories_work.md
      - Exporting Your Portfolio: exporting_your_portfolio.md
      - Tutorial & Example: tutorial_example.md
      - Beancount History and Credits: beancount_history_and_credits.md
      - A Comparison of Beancount and Ledger Hledger: a_comparison_of_beancount_and_ledger_hledger.md
      - Fetching Prices in Beancount: fetching_prices_in_beancount.md
      - Importing External Data: importing_external_data.md
    - Cookbooks & Examples:
      - Command Line Accounting Cookbook: command_line_accounting_cookbook.md
      - Trading with Beancount: trading_with_beancount.md
      - Stock Vesting in Beancount: stock_vesting_in_beancount.md
      - Sharing Expenses with Beancount: sharing_expenses_with_beancount.md
      - How We Share Expenses: how_we_share_expenses.md
      - Health Care Expenses: health_care_expenses.md
      - Calculating Portfolio Returns: calculating_portolio_returns.md
      - Tracking Out-of-Network Medical Claims in Beancount: tracking_medical_claims.md
    - Documentation for Developers:
      - Beancount Scripting Plugins: beancount_scripting_plugins.md
      - Beancount Design Doc: beancount_design_doc.md
      - Ledgerhub Design Doc: ledgerhub_design_doc.md
      - External Contributions: external_contributions.md
    - Enhancement Proposals & Discussions:
      - A Proposal for an Improvement on Inventory Booking: a_proposal_for_an_improvement_on_inventory_booking.md
      - Settlement Dates in Beancount: settlement_dates_in_beancount.md
      - Balance Assertions in Beancount: balance_assertions_in_beancount.md
      - Fund Accounting with Beancount: fund_accounting_with_beancount.md
      - Rounding Precision in Beancount: rounding_precision_in_beancount.md
    - Beancount 3:
      - Goals & Design: beancount_v3.md
      - Installing Beancount: installing_beancount_v3.md
      - Dependencies: beancount_v3_dependencies.md
      - Beangulp: beangulp.md
  - API reference:
    - beancount: api_reference/index.md
    - api_reference/beancount.core.md
    - api_reference/beancount.loader.md
    - api_reference/beancount.ops.md
    - api_reference/beancount.parser.md
    - api_reference/beancount.plugins.md
    - api_reference/beancount.scripts.md
    - api_reference/beancount.tools.md
    - api_reference/beancount.utils.md

extra_css:
  - css/custom.css
extra_javascript:
  - javascripts/shortcuts.js
  - javascripts/header.js

extra:
  version:
    provider: mike

markdown_extensions:
  - tables
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - toc:
      permalink: 
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.mark
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tilde
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.extra:
      pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - sane_lists

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

plugins:
  - search
  - social
  - glightbox
  - mike
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_object_full_path: true
            # 3 because docs are in pages with an H2 just above them
            heading_level: 3
            filters:
              - "!_test$"
              - "!^_[^_]"
          inventories:
            - url: https://docs.python.org/3/objects.inv
            - url: https://docs.pydantic.dev/latest/objects.inv
  - redirects:
      redirect_maps:
        'g/export/index.md': 'https://docs.google.com/document/d/1mNyE_ONuyEkF_I2l6V_AoAU5HJgI654AOBhHsnNPPqw/'