mkdocs.yml

site_name: Quantilica — Dados Públicos Brasileiros
site_description: Ferramentas resilientes em Python para extrair, normalizar e analisar dados públicos brasileiros — IBGE, Tesouro, DATASUS, INMET, CAGED, RAIS, Comex.
site_author: Quantilica
site_url: https://docs.quantilica.com
copyright: "Copyright &copy; 2026 Quantilica &bull; <a href=\"#__consent\">Alterar preferências de cookies</a>"

repo_url: https://github.com/Quantilica/docs
repo_name: Quantilica
edit_uri: ""

theme:
  name: material
  custom_dir: overrides
  logo: assets/logo.png
  favicon: assets/favicon.ico
  language: pt-BR
  font:
    code: Google Sans Code
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.highlight
    - search.suggest
    - search.share
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Modo escuro
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Modo claro

nav:
  - Início: index.md
  - Começar em 5 minutos: quickstart.md

  - Conceitos:
      - concepts/index.md
      - Princípios de Design: concepts/principios.md
      - Arquitetura do Ecossistema: concepts/arquitetura.md
      - Padrões Práticos: concepts/padroes.md
      - Parquet + Polars: concepts/parquet-polars.md
      - Convenções de Armazenamento: concepts/storage.md
      - Proveniência & Manifestos: concepts/proveniencia.md
      - Bulk Load & Versionamento: concepts/bulk-load.md
      - Cálculo de Retornos (Renda Fixa): concepts/calculo-retornos-renda-fixa.md

  - Fundações:
      - fundacoes/index.md
      - quantilica-core: fundacoes/quantilica-core.md
      - quantilica-analytics: fundacoes/quantilica-analytics.md
      - quantilica-cli: fundacoes/quantilica-cli.md
      - quantilica-catalog: fundacoes/quantilica-catalog.md

  - Domínios & Ferramentas:
      - IBGE (Macroeconomia):
          - ibge/index.md
          - sidra-fetcher: ibge/sidra-fetcher.md
          - sidra-sql: ibge/sidra-sql.md
          - sidra-pipelines: ibge/sidra-pipelines.md
      - Tesouro (Finanças):
          - tesouro/index.md
          - tesouro-direto-fetcher: tesouro/tesouro-direto-fetcher.md
          - rtn-fetcher: tesouro/rtn-fetcher.md
      - Banco Central (BCB):
          - bcb/index.md
          - bcb-sgs-fetcher: bcb/bcb-sgs-fetcher.md
          - bcb-sgs-sql: bcb/bcb-sgs-sql.md
      - Mercado de Trabalho:
          - trabalho/index.md
          - pdet-fetcher: trabalho/pdet-fetcher.md
      - Comércio Exterior:
          - comex/index.md
          - comex-fetcher: comex/comex-fetcher.md
      - Saúde Pública:
          - saude/index.md
          - datasus-fetcher: saude/datasus-fetcher.md
      - Clima & Meio Ambiente:
          - clima/index.md
          - inmet-fetcher: clima/inmet-fetcher.md

  - Cookbook:
      - cookbook/index.md
      - Curva de Phillips brasileira: cookbook/curva-phillips.md
      - Yield Curve em 10 linhas: cookbook/yield-curve.md
      - Mortalidade infantil × SUS: cookbook/mortalidade-sus.md
      - Estiagem no Nordeste: cookbook/estiagem-nordeste.md
      - Balança comercial em DuckDB: cookbook/balanca-duckdb.md
      - Time Travel — paper de 2019: cookbook/time-travel.md
      - Análise Econômica Multi-Fonte: cookbook/analise-economica-multi-fonte.md

  - Por persona:
      - personas/index.md
      - Analista macroeconômico: personas/analista-macro.md
      - Cientista de saúde pública: personas/cientista-saude.md
      - Engenheiro de dados: personas/engenheiro-dados.md
      - Pesquisador acadêmico: personas/pesquisador.md

  - Desenvolvimento:
      - Padronização de Versão: normas/python.md
      - Padrões de Escrita: normas/escrita.md
      - Padronização de CLI: normas/cli-fetchers.md
      - Padronização de .gitignore: normas/gitignore.md
      - Padronização de pyproject.toml: normas/pyproject.md
      - Publicação e Release: normas/publicacao.md
      - Configuração Global: normas/configuracao.md

  - Contribuir: contribuir.md
  - Status das fontes: status.md
  - Roadmap: roadmap.md
  - Changelog: changelog.md

plugins:
  - search:
      lang:
        - pt
        - en
  # Para ativar o plugin social (gera og-image automaticamente por página),
  # instale `mkdocs-material[imaging]` e descomente o bloco abaixo:
  # - social:
  #     cards_layout_options:
  #       background_color: "#3f51b5"
  #       color: "#ffffff"

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra:
  generator: false
  analytics:
    provider: custom
    property: !ENV [GOOGLE_ANALYTICS_KEY, ""]
    umami_website_id: !ENV [UMAMI_WEBSITE_ID, ""]
    umami_script_url: !ENV [UMAMI_SCRIPT_URL, "https://cloud.umami.is/script.js"]
  consent:
    title: Controle de Privacidade e Cookies
    description: >-
      Utilizamos cookies e tecnologias semelhantes para nos ajudar a entender como você utiliza o nosso site, melhorar a sua experiência e medir o tráfego de documentação. Ao aceitar, você concorda com o uso de cookies para fins de análise estatística.
    actions:
      - accept
      - reject
      - manage
    cookies:
      analytics: Google Analytics & Umami Analytics
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Quantilica
      name: Quantilica no GitHub
  mathjax_config:
    tex:
      inlineMath: [['$', '$'], ['\\(', '\\)']]
      displayMath: [['$$', '$$'], ['\\[', '\\]']]

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format