mkdocs.yml

site_name: A Hamilton-Jacobi-based proximal operator
site_description: A formula for estimating proximal operators from (possibly noisy) observations of objective function values

extra_css:
  - stylesheets/extra.css
 
plugins:
  - search
  - mkdocstrings
  - mkdocs-jupyter:
      include_source: True
      include: ["*.ipynb"]
  - social:
      cards_color:
        fill: "#7086DF" 
        text: "#FFFFFF"
  
theme:
  name: material
  logo: assets/logo-v3-light.png
  favicon: assets/logo-v3-dark.png
  palette:
    scheme: default  
  features:
    - content.code.annotation
    - content.code.copy
  language: en
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - toc.integrate
    - navigation.top
    - navigation.expand
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy



extra:
  social:
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/TypalAcademy  
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/TypalAcademy
    - icon: fontawesome/brands/vimeo
      link: https://vimeo.com/TypalAcademy    
    - icon: fontawesome/brands/youtube
      link: https://youtube.com/@TypalAcademy    
  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 are searching for. Your consent helps make this site better.
    cookies:
      analytics:
        name: Google Analytics
        checked: true
  analytics:
    provider: google
    property: G-8WCEEZSZ9B  

# Github Repo
repo_name: mines-opt-ml/hj-prox
repo_url: https://github.com/mines-opt-ml/hj-prox


markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.pathconverter
  - pymdownx.tasklist:
      custom_checkbox: true  
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
    - 'HJ Prox': 'index.md'
    - 'Core Function': 'hj-prox.md'
    - 'Experiments':
        - 'L1 + Least Squares': 'exp-l1-least-squares.ipynb'
        - 'Proximal Comparisons': 'exp-prox-comparison.ipynb'
        - 'Noisy Oracle + Constraints': 'exp-oracle-constraints.ipynb'        

copyright: |
  &copy; 2023 <a href="https://research.typal.academy"  target="_blank" rel="noopener">Typal Academy LLC</a>
  <br>
  <a href="#__consent">Cookie Settings</a>