mkdocs.yml

site_name: OpenRetailScience
site_url: https://openretailscience.datasimply.co
repo_url: https://github.com/Data-Simply/openretailscience
repo_name: Data-Simply/openretailscience

# Build-helper tooling, not documentation pages — keep out of the rendered site.
exclude_docs: |
  scripts/

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting_started/installation.md
      - Connecting to Your Data: getting_started/connecting_to_data.md
      - Options & Configuration: getting_started/options_guide.md
      - Plot Styling Guide: getting_started/styling_guide.ipynb
  - Analysis Modules:
      - analysis_modules.md
  - Experimental:
      - Metrics: experimental/metrics.md
  - Plot Gallery:
      - Overview: gallery/index.md
      - Area Plot: gallery/plots/area.ipynb
      - Bar Plot: gallery/plots/bar.ipynb
      - Broken Timeline Plot: gallery/plots/broken_timeline.ipynb
      - Cohort Plot: gallery/plots/cohort.ipynb
      - Customer Decision Hierarchy: gallery/plots/customer_decision_hierarchy.ipynb
      - Heatmap Plot: gallery/plots/heatmap.ipynb
      - Histogram Plot: gallery/plots/histogram.ipynb
      - Line Plot: gallery/plots/line.ipynb
      - Period on Period Plot: gallery/plots/period_on_period.ipynb
      - Revenue Tree: gallery/plots/revenue_tree.ipynb
      - Time Plot: gallery/plots/time.ipynb
      - Venn Diagram: gallery/plots/venn.ipynb
      - Waterfall Plot: gallery/plots/waterfall.ipynb
      - Index Plot: gallery/plots/index_plot.ipynb
      - Scatter Plot: gallery/plots/scatter.ipynb
      - Price Plot: gallery/plots/price.ipynb
  - Examples:
      - Customer Retention: examples/retention.ipynb
      - Gain Loss Analysis: examples/gain_loss.ipynb
      - Cross Shop Analysis: examples/cross_shop.ipynb
      - Segmentation: examples/segmentation.ipynb
      - Product Association: examples/product_association.ipynb
      - Revenue Tree: examples/revenue_tree.ipynb
  - Reference:
      - Options: api/options.md
      - Analysis:
          - Cohort Analysis: api/analysis/cohort.md
          - Cross Shop Analysis: api/analysis/cross_shop.md
          - Customer Retention: api/analysis/customer.md
          - Gain Loss: api/analysis/gain_loss.md
          - Haversine Distance: api/analysis/haversine.md
          - Product Association: api/analysis/product_association.md
          - Customer Decision Hierarchy: api/analysis/customer_decision_hierarchy.md
          - Revenue Tree: api/analysis/revenue_tree.md
          - Composite Rank: api/analysis/composite_rank.md
      - Segmentation:
          - HML Segmentation: api/segmentation/hml.md
          - RFM Segmentation: api/segmentation/rfm.md
          - SegTransactionStats Segmentation: api/segmentation/segstats.md
          - NLR Segmentation: api/segmentation/nlr.md
          - Threshold Segmentation: api/segmentation/threshold.md
      - Plots:
          - Area Plot: api/plots/area.md
          - Bar Plot: api/plots/bar.md
          - Broken Timeline Plot: api/plots/broken_timeline.md
          - Cohort Plot: api/plots/cohort.md
          - Histogram Plot: api/plots/histogram.md
          - Heatmap Plot: api/plots/heatmap.md
          - Index Plot: api/plots/index.md
          - Line Plot: api/plots/line.md
          - Period On Period Plot: api/plots/period_on_period.md
          - Scatter Plot: api/plots/scatter.md
          - Time Plot: api/plots/time.md
          - Price Plot: api/plots/price.md
          - Venn Diagram: api/plots/venn.md
          - Waterfall Plot: api/plots/waterfall.md
          - Styles:
              - Graph Utils: api/plots/styles/graph_utils.md
              - Styling Helpers: api/plots/styles/styling_helpers.md
      - Experimental:
          - Metrics:
              - Distribution: api/experimental/metrics/distribution.md
      - Utils:
          - Date Utils: api/utils/date.md
          - Filter & Label Utils: api/utils/filter_and_label.md
          - Label Utils: api/utils/label.md

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - content.code.annotation
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.integrate
  language: en
  palette:
    primary: custom
  font:
    text: Poppins
    code: Roboto Mono
  logo: assets/images/logo.svg
  favicon: assets/images/logo.svg
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3.2.2/es5/tex-mml-chtml.js

plugins:
  - search
  - mkdocstrings
  - autorefs
  - mkdocs-jupyter:
      execute: false
      remove_tag_config:
        remove_cell_tags:
          - remove_cell
        remove_input_tags:
          - hide_input

markdown_extensions:
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true

extra:
  analytics:
    provider: google
    property: G-7S7YSNJ82W
  consent:
    actions:
      - accept
      - manage
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Data-Simply/openretailscience
      name: OpenRetailScience on GitHub

copyright: |
  &copy; 2025 <a href="https://datasimply.co"  target="_blank" rel="noopener">Murray Vanwyk</a> -
  <a href="#__consent">Change cookie settings</a>