actionet-python/mkdocs.yml at main · KellisLab/actionet-python · 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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
site_name: ACTIONet (Python)
site_description: Python front-end for the ACTIONet single-cell analysis toolkit.
site_url: https://kellislab.github.io/actionet-python/
repo_url: https://github.com/KellisLab/actionet-python
repo_name: KellisLab/actionet-python
edit_uri: edit/dev/docs/

docs_dir: docs

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            filters:
              - "!^_"
            merge_init_into_class: true
            heading_level: 2

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Guides:
      - Guide calling: guide_calling.md
      - Batch correction benchmark: batch_correction_benchmark.md
  - API Reference:
      - Overview: api/index.md
      - Pipeline: api/pipeline.md
      - Action: api/action.md
      - Decomposition: api/decomposition.md
      - Network: api/network.md
      - Annotation: api/annotation.md
      - Preprocessing: api/preprocessing.md
      - Visualization: api/visualization.md
      - Tools: api/tools.md
      - Batch correction: api/batch_correction.md
      - Guide calling: api/guide_calling.md
      - I/O and backed persistence: api/io.md