# MkDocs Configuration for SQA CLI Documentation

site_name: SQA CLI - Simple Qualitative Analysis

site_description: A command-line interface for financial market analysis, backtesting, and portfolio optimization

site_author: Dewayne VanHoozer

site_url: https://madbomber.github.io/sqa-cli

copyright: Copyright © 2024 Dewayne VanHoozer

# Repository information

repo_name: madbomber/sqa-cli

repo_url: https://github.com/madbomber/sqa-cli

edit_uri: edit/main/docs/

# Configuration

theme:

name: material

# Color scheme - Default to light mode

palette:

# Palette toggle for light mode (default)

- scheme: default

primary: blue

accent: blue

toggle:

icon: material/brightness-7

name: Switch to dark mode

# Palette toggle for dark mode

- scheme: slate

primary: blue

accent: blue

toggle:

icon: material/brightness-4

name: Switch to light mode

# Typography

font:

text: Roboto

code: Roboto Mono

# Theme features

features:

# Navigation

- navigation.instant

- navigation.tracking

- navigation.tabs

- navigation.tabs.sticky

- navigation.sections

- navigation.path

- navigation.indexes

- navigation.top

# Table of contents

- toc.follow

# Search

- search.suggest

- search.highlight

- search.share

# Header

- header.autohide

# Content

- content.code.copy

- content.code.annotate

- content.tabs.link

- content.tooltips

- content.action.edit

- content.action.view

# Plugins

plugins:

- search:

separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

# Extensions

markdown_extensions:

# Python Markdown

- abbr

- admonition

- attr_list

- def_list

- footnotes

- md_in_html

- toc:

permalink: true

title: On this page

# Python Markdown Extensions

- pymdownx.arithmatex:

generic: true

- pymdownx.betterem:

smart_enable: all

- pymdownx.caret

- pymdownx.details

- pymdownx.emoji:

emoji_generator: !!python/name:material.extensions.emoji.to_svg

emoji_index: !!python/name:material.extensions.emoji.twemoji

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.keys

- pymdownx.magiclink:

repo_url_shorthand: true

user: madbomber

repo: sqa-cli

- pymdownx.mark

- pymdownx.smartsymbols

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.tabbed:

alternate_style: true

- pymdownx.tasklist:

custom_checkbox: true

- pymdownx.tilde

# Extra CSS and JavaScript

extra_css:

- assets/css/custom.css

extra_javascript:

- assets/js/mathjax.js

- https://polyfill.io/v3/polyfill.min.js?features=es6

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

# Social media and extra configuration

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/madbomber/sqa-cli

name: SQA CLI on GitHub

- icon: fontawesome/solid/gem

link: https://rubygems.org/gems/sqa

name: SQA gem on RubyGems

# Navigation

nav:

- Home: index.md

- Quick Start: quickstart.md

- Installation: installation.md

- Guides:

- Usage Examples: usage.md

- Sample Data: data.md

- Commands:

- Analyze: commands/analyze.md

- Backtest: commands/backtest.md

- Pattern Discovery: commands/pattern.md

- Genetic Programming: commands/genetic.md

- Knowledge-Based Strategy: commands/kbs.md

- Stream Simulation: commands/stream.md

- Portfolio Optimization: commands/optimize.md

- Reference:

- CLI Reference: cli-reference.md

- Architecture: architecture.md

- Development:

- Status: status.md

- Testing: testing.md

- Contributing: contributing.md