mkdocs.yml

site_name: Flowdyn
repo_name: flowdyn
repo_url: https://github.com/jgressier/flowdyn
edit_uri: ''  #disables edit button

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  language: en
  features:
    - navigation.tabs

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - User Guide:
    - Starting guide: userguide/start.md
    - Models: 
      - model definition: userguide/models.md
      - convection: userguide/models/convection.md
      - Burgers: userguide/models/burgers.md
      - shallow water: userguide/models/shallowwater.md
      - Euler: userguide/models/euler.md
    - Models: userguide/models.md
    - Numerical methods: userguide/num.md
  - Examples: 
    - Examples: examples.md
    - Nozzle: examples/euler-nozzle.ipynb
    - Rayleigh flow: examples/euler-rayleigh-flow.ipynb
  - Code reference: 
    - flowdyn.monitors: coderef/flowdyn.monitors.md
  - About: 
    - About: about.md
    - Change log: changelog.md

plugins:
  - search
  - include-markdown
  - mkdocs-jupyter:
      execute: True
      include_source: False
  - exclude:
      glob:
        - ".ipynb_checkpoints"
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_root_heading: false
            show_source: true
            show_category_heading: true
          selection:
            #docstring_style: "restructured-text" # default is "google"
            filters:
              - "!^_"  # exclude all members starting with _