multiscoresplot/mkdocs.yml at main · AndreMacedo88/multiscoresplot · 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
site_name: multiscoresplot
site_url: https://AndreMacedo88.github.io/multiscoresplot/
site_description: Multi-dimensional gene set scoring and visualization for single-cell transcriptomics
site_author: Andre Macedo

repo_name: AndreMacedo88/multiscoresplot
repo_url: https://github.com/AndreMacedo88/multiscoresplot

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Pipeline Guide: pipeline.md
  - API Reference:
      - Overview: api/index.md
      - plot_scores: api/pipeline.md
      - score_gene_sets: api/scoring.md
      - blend_to_rgb & reduce_to_rgb: api/colorspace.md
      - plot_embedding: api/plotting.md
      - plot_embedding_interactive: api/interactive.md
      - render_legend: api/legend.md
  - Examples: examples.md
  - Changelog: changelog.md

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_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AndreMacedo88/multiscoresplot
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/multiscoresplot/