spoc/mkdocs.yml at master · gerlichlab/spoc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
site_name: Spoc
repo_url: https://github.com/gerlichlab/spoc
repo_name: gerlichlab/spoc
dev_addr: 127.0.0.1:8000
theme:
  name: material
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
nav:
  - Getting Started:
    - Welcomde to spoc: index.md
    - Installation: installation.md
    - Load example dataset: load_example_dataset.md
    - Transformation pipeline: transformation_pipeline.md
  - Data Structures: data_structures.md
  - Query Engine:
    - Usage guide: query_engine_usage.md
    - Class interface: query_engine_interface.md
  - Contributing: contributing.md
  - API:
    - CLI: cli.md
    - IO: io.md
    - Contacts: contacts.md
    - Fragments: fragments.md
    - Pixels: pixels.md
    - Query Engine: query_engine.md
    - Dataframe models: dataframe_models.md
    - File parameters models: file_parameters_models.md
plugins:
  - mkdocstrings
  - search
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - tables