mkdocs.yml

site_name: FoaPy
site_description: "FoaPy is a Python package for formal order analysis of sequences"
nav:
- "Home": index.md
- "Fundamentals":
  - fundamentals/index.md
  - "Ideas":
    - fundamentals/ideas/index.md
    - "Sequence as a whole object": fundamentals/ideas/sequence_as_a_whole_object.md
    - "Order as a property": fundamentals/ideas/order_as_a_property.md
    - "Congeneric decomposition": fundamentals/ideas/congeneric_decomposition.md
    - "Interval as a basic information unit": fundamentals/ideas/interval_as_a_basic_information_unit.md
    - "Geomteric mean as alternative to probability": fundamentals/ideas/geometric_mean_based_characteristics.md
  - "Order and its measures":
    - fundamentals/order/index.md
    - "Carrier set": fundamentals/order/carrier_set.md
    - "Sequence": fundamentals/order/sequence.md
    - "Alphabet": fundamentals/order/alphabet.md
    - "Order": fundamentals/order/order.md
    - "Intervals Chain":
      - fundamentals/order/intervals_chain/index.md
      - "Bounded": fundamentals/order/intervals_chain/bounded.md
      - "Cycled": fundamentals/order/intervals_chain/cycled.md
    - "Intervals Distribution":
      - fundamentals/order/intervals_distribution/index.md
      - "Lossy": fundamentals/order/intervals_distribution/lossy.md
      - "Redundant": fundamentals/order/intervals_distribution/redundant.md
    - "Characteristics":
      - fundamentals/order/characteristics/index.md
      - "Arithmetic mean": fundamentals/order/characteristics/arithmetic_mean.md
      - "Geometric mean": fundamentals/order/characteristics/geometric_mean.md
      - "Volume": fundamentals/order/characteristics/volume.md
      - "Average remoteness": fundamentals/order/characteristics/average_remoteness.md
      - "Depth": fundamentals/order/characteristics/depth.md
  - "Partials and congenerics":
    - fundamentals/partials_and_congenerics/index.md
    - "Carrier set": fundamentals/partials_and_congenerics/carrier_set.md
    - "Sequence":
      - fundamentals/partials_and_congenerics/sequence/index.md
      - "Congeneric": fundamentals/partials_and_congenerics/sequence/congeneric.md
    - "Alphabet":
      - fundamentals/partials_and_congenerics/alphabet/index.md
      - "Congeneric": fundamentals/partials_and_congenerics/alphabet/congeneric.md
    - "Order":
      - fundamentals/partials_and_congenerics/order/index.md
      - "Congeneric": fundamentals/partials_and_congenerics/order/congeneric.md
    - "Intervals chain":
      - fundamentals/partials_and_congenerics/intervals_chain/index.md
      - "Congeneric": fundamentals/partials_and_congenerics/intervals_chain/congeneric.md
    - "Intervals distribution": fundamentals/partials_and_congenerics/intervals_distribution.md
    - "Characteristics": fundamentals/partials_and_congenerics/characteristics.md
  - "Congeneric decomposition":
    - fundamentals/congeneric_decomposition/index.md
    - "Sequences": fundamentals/congeneric_decomposition/sequences.md
    - "Alphabet": fundamentals/congeneric_decomposition/alphabet.md
    - "Orders": fundamentals/congeneric_decomposition/orders.md
    - "Intervals chains": fundamentals/congeneric_decomposition/intervals_chains.md
    - "Intervals distribution": fundamentals/congeneric_decomposition/intervals_distribution.md
    - "Characteristics":
      - fundamentals/congeneric_decomposition/characteristics/index.md
      - "Descriptive informations": fundamentals/congeneric_decomposition/characteristics/descriptive_information.md
      - "Identifying information": fundamentals/congeneric_decomposition/characteristics/identifying_information.md
      - "Regularity": fundamentals/congeneric_decomposition/characteristics/regularity.md
      - "Uniformity": fundamentals/congeneric_decomposition/characteristics/uniformity.md
  # - "Connections to other mathfields":
  #   - fundamentals/connections_to_other_mathfields/index.md
  #   - "Information theory": fundamentals/connections_to_other_mathfields/information_theory.md
  #   - "Probability theory": fundamentals/connections_to_other_mathfields/probability_theory.md
  #   - "Statistics": fundamentals/connections_to_other_mathfields/statistics.md
  #   - "Combinatorics": fundamentals/connections_to_other_mathfields/combinatorics.md
  # - "Applications":
  #   - fundamentals/applications/index.md
  #   - "Text mining": fundamentals/applications/text_mining.md
  #   - "Bioinformatics": fundamentals/applications/bioinformatics.md
  #   - "Music analysis": fundamentals/applications/music_analysis.md
  #   - "Other applications": fundamentals/applications/other_applications.md
- "References":
  - "foapy.alphabet": references/alphabet.md
  - "foapy.order": references/order.md
  - "foapy.intervals": references/intervals.md
  - "foapy.binding": references/binding.md
  - "foapy.mode": references/mode.md
  - "foapy.ma":
    - references/ma/index.md
    - "alphabet": references/ma/alphabet.md
    - "order": references/ma/order.md
    - "intervals": references/ma/intervals.md
  - "foapy.characteristics":
    - references/characteristics/index.md
    - "arithmetic_mean": references/characteristics/arithmetic_mean.md
    - "average_remoteness": references/characteristics/average_remoteness.md
    - "depth": references/characteristics/depth.md
    - "descriptive_information": references/characteristics/descriptive_information.md
    - "geometric_mean": references/characteristics/geometric_mean.md
    - "identifying_information": references/characteristics/identifying_information.md
    - "regularity": references/characteristics/regularity.md
    - "uniformity": references/characteristics/uniformity.md
    - "volume": references/characteristics/volume.md
    - "ma":
      - references/characteristics/ma/index.md
      - "arithmetic_mean": references/characteristics/ma/arithmetic_mean.md
      - "average_remoteness": references/characteristics/ma/average_remoteness.md
      - "depth": references/characteristics/ma/depth.md
      - "geometric_mean": references/characteristics/ma/geometric_mean.md
      - "identifying_information": references/characteristics/ma/identifying_information.md
      - "periodicity": references/characteristics/ma/periodicity.md
      - "uniformity": references/characteristics/ma/uniformity.md
      - "volume": references/characteristics/ma/volume.md
  - "foapy.exceptions":
    - references/exceptions/index.md
    - "InconsistentOrderException": references/exceptions/inconsistent_order.md
    - "Not1DArrayException": references/exceptions/not_1d_array.md
- Development:
  - "Development": development/development.md
  - "Benchmarks": development/benchmarks.md
  - "Code coverage": development/coverage.md

# ⚠️ WARNING ⚠️
# =============
# DO NOT EDIT ANY CONFIGURATION BELOW THIS LINE
# The settings below are required for proper documentation generation
# =============
edit_uri: edit/main/docs/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.indexes
    - navigation.tracking
    # - toc.follow
    # - toc.integrate
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
repo_url: https://github.com/intervals-mining-lab/foapy
repo_name: intervals-mining-lab/foapy
extra:
  consent:
    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.
    button:
      text: Accept
      icon: mdi:cookie
  version:
    provider: mike
    alias: true
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
- autorefs
- markdown-exec
- coverage:
    page_path: development/coverage  # default
    html_report_dir: htmlcov  # default
- mkdocstrings:
    default_handler: python
    enable_inventory: true
    handlers:
      python:
        options:
          parameter_headings: true
          show_root_toc_entry: false
          docstring_style: numpy
          show_submodules: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          show_root_heading: true
          show_signature_annotations: false
          separate_signature: false
          unwrap_annotated: true
          show_if_no_docstring: false
          show_labels: false
          show_root_full_path: false
- mike:
    # These fields are all optional; the defaults are as below...
    alias_type: symlink
    redirect_template: null
    deploy_prefix: ''
    canonical_version: null
    version_selector: true
    css_dir: assets/css
    javascript_dir: assets/js
hooks:
  - docs-hooks.py

extra_javascript:
  - assets/js/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - assets/js/posthog.js

extra_css:
  - assets/css/custom.css