mkdocs.yml

site_name: Felis Documentation
site_url: "https://felis.alice-bob.com/docs"
theme: 
  name: material
  custom_dir: docs/overrides
  logo: media/logo-ab.png
  favicon: media/favicon.ico
  features:
    - navigation.instant
    - navigation.tabs
nav:
  - Home: index.md
  - Getting started:
    - Install the Qiskit provider: getting_started/install_the_qiskit_provider.md
    - An example with physical qubits: getting_started/physical_example.md
    - An example with logical qubits: getting_started/logical_example.md
    - "Working with cat qubits: similarities & differences": getting_started/working_with_cat_qubits.md
    - Why work with cat qubits?: getting_started/why_cat_qubits.md
    - Sample notebook library: getting_started/sample_notebooks.md

  - Felis Cloud: 
    - About Felis Cloud: felis_cloud/about_felis_cloud.md
    - Connect to Felis Cloud: felis_cloud/connect_to_felis_cloud.md
    - Hardware availability schedule: felis_cloud/hardware_availability_schedule.md
    - How to run multiple circuits remotely: felis_cloud/run_multiple_circuits.md

  - Backends:
    - About backends: backends/about_backends.md
    - Logical and physical backends: backends/logical_physical.md
    - Set backends parameters: backends/set_parameters.md
    - List of available backends:
      - "QPU:1Q:BOSON_4A (or 4B, or 4C)": backends/backends_list/boson_4.md
      - "EMU:1Q:LESCANNE_2020": backends/backends_list/lescanne_2020.md
      - "EMU:6Q:PHYSICAL_CATS": backends/backends_list/6_physical_cats.md
      - "EMU:40Q:PHYSICAL_CATS": backends/backends_list/40_physical_cats.md
      - "EMU:15Q:LOGICAL_EARLY": backends/backends_list/logical_early.md
      - "EMU:40Q:LOGICAL_TARGET": backends/backends_list/logical_target.md

  - Reference:
    - Frequently asked questions: reference/faq.md
    - Supported instructions: reference/supported_instructions.md
    - Useful scientific papers: reference/papers.md
    - Error models in emulators: reference/error_models.md
    - Boson 4 chips: reference/boson_4_chips.md
    - The Felis API: reference/the_api.md
    - Felis changelog: reference/changelog.md
    - About the Qiskit provider: reference/about_the_provider.md

  - Contact us: contact_us.md

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
extra_css:
  - stylesheets/extra.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
extra_javascript:
  - javascripts/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js