mkdocs.yml

site_name: EdgarTools - Python Library for SEC Data Analysis
site_description: Access and analyze SEC filings, financial statements, insider trading, and investment fund data
repo_url: https://github.com/dgunning/edgartools
repo_name: dgunning/edgartools

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/nav-enhance.js

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.sections
    #- navigation.expand
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.code.copy
    - toc.follow

nav:
  # ==========================================
  # GET STARTED - New users, first 10 minutes
  # ==========================================
  - Get Started:
    - Overview: index.md
    - Installation: installation.md
    - Quick Start: quickstart.md
    - Complete Guide: complete-guide.md
    - Choosing the Right API: xbrl/getting-started/choosing-the-right-api.md
    - Common Pitfalls: common-pitfalls.md
    - Cheat Sheet: quick-guide.md
    - Key Concepts: concepts/sec-filings.md

  # ==========================================
  # COMPANY - Find and analyze companies
  # ==========================================
  - Company:
    - Find a Company: guides/finding-companies.md
    - Company Subsets: company-subsets.md
    - Track Insiders: guides/company-insiders.md
    - Entity API: guides/entity-api-guide.md
    - Company Classification: guides/company-classification.md
    - Business Development Companies: guides/bdc-guide.md
    - Reference Data: guides/reference-data.md

  # ==========================================
  # FILINGS - Access SEC filings
  # ==========================================
  - Filings:
    - Working with Filings: guides/working-with-filing.md
    - Search & Filter: guides/searching-filings.md
    - Full-Text Search & Grep: guides/full-text-search.md
    - Filter by Criteria: guides/filtering-filings.md
    - Current Filings: guides/current-filings.md
    - Attachments: guides/filing-attachments.md
    - Examples: examples.md

  # ==========================================
  # FILING TYPES - Parsed filing data objects
  # ==========================================
  - Filing Types:
    - Overview: data-objects.md
    - Annual & Quarterly: concepts/data-objects.md
    - Current Events (8-K): eightk-filings.md
    - Foreign Issuer Reports (6-K): guides/sixk-data-object-guide.md
    - Insider Trades (Form 4): insider-filings.md
    - Track Insider Activity: guides/track-form4.md
    - Beneficial Ownership (13D/G): guides/schedule13dg-data-object-guide.md
    - Institutional Holdings (13F): guides/thirteenf-data-object-guide.md
    - Fund Portfolios (N-PORT): guides/nport-data-object-guide.md
    - Money Market Funds (N-MFP): guides/moneymarketfund-data-object-guide.md
    - Fund Census (N-CEN): guides/fundcensus-data-object-guide.md
    - Fund Shareholder Reports (N-CSR): guides/fundshareholderreport-data-object-guide.md
    - Fund Fee Notices (24F-2NT): guides/twentyfourf-data-object-guide.md
    - Proxy Statements (DEF 14A): guides/proxystatement-data-object-guide.md
    - Private Offerings (Form D): guides/formd-data-object-guide.md
    - Crowdfunding (Form C): guides/formc-data-object-guide.md
    - Sale Notices (Form 144): guides/form144-data-object-guide.md
    - Fund Voting (N-PX): guides/npx-data-object-guide.md
    - ABS Distribution (10-D): guides/tend-data-object-guide.md
    - Prospectus Supplements (424B): guides/prospectus424b-data-object-guide.md
    - Shelf Registrations (S-3): guides/registration-s3-data-object-guide.md
    - Municipal Advisors (MA-I): guides/mai-data-object-guide.md
    - SEC Correspondence (CORRESP): guides/correspondence-data-object-guide.md

  # ==========================================
  # FINANCIALS - Financial statements & data
  # ==========================================
  - Financials:
    - Overview: guides/financial-data.md
    - Extract Financial Statements: guides/extract-statements.md
    - Company Facts: guides/company-facts.md
    - Multi-Period Analysis: guides/multi-year-financial-data-api.md
    - Stock Splits & EPS Normalization: guides/stock-splits-eps-normalization.md
    - Equity Statement Data Layers: guides/equity-statement-data-layers.md
    - XBRL Deep Dive:
      - Overview: xbrl/index.md
      - Query XBRL Facts: xbrl-querying.md
      - Getting XBRL Data: getting-xbrl.md
      - Multi-Period Analysis: xbrl/guides/multi-period-analysis.md
      - Dimensions: xbrl/concepts/dimension-handling.md
      - Standardization: xbrl/concepts/standardization.md
      - Footnotes: guides/xbrl-footnotes.md
      - SEC Interactive Viewer: guides/sec-viewer-guide.md

  # ==========================================
  # AI - MCP server & skills for AI agents
  # ==========================================
  - AI Integration:
    - Overview: ai/index.md
    - MCP Server:
      - Setup: ai/mcp-setup.md
      - Tools Reference: ai/mcp-tools.md
      - Workflows: ai/mcp-workflows.md
    - Skills: ai/skills.md

  # ==========================================
  # NOTEBOOKS - Interactive Colab tutorials
  # ==========================================
  - Notebooks: notebooks.md

  # ==========================================
  # ADVANCED - Power users & customization
  # ==========================================
  # ==========================================
  # API REFERENCE - Detailed class documentation
  # ==========================================
  - API Reference:
    - Company: api/company.md
    - Filing: api/filing.md
    - Filings: api/filings.md
    - XBRL: api/xbrl.md
    - Entity Facts: api/entity-facts-reference.md

  - Advanced:
    - Configuration: configuration.md
    - Storage:
      - Local Storage: guides/local-storage.md
      - Cloud Storage (S3): guides/cloud-storage.md
    - Advanced Search: advanced-search.md
    - Customizing Standardization: advanced/customizing-standardization.md
    - Reference:
      - Form Types: FormType-Quick-Reference.md
      - Period Types: PeriodType-Quick-Reference.md
      - Statement Types: StatementType-Quick-Reference.md
    - SEC Compliance: resources/sec-compliance.md
    - Troubleshooting: resources/troubleshooting.md
    - Performance: resources/performance.md
    - Contributing: contributing.md
    - About the Creator: about.md