graphld/mkdocs.yml at main · oclb/graphld · 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
site_name: GraphLD
site_description: Graph-based linkage disequilibrium matrix operations and heritability estimation
site_url: https://github.com/oclb/graphld
repo_url: https://github.com/oclb/graphld
repo_name: oclb/graphld

extra:
  version: "1.2.0"  # Updated by hooks.py from pyproject.toml

hooks:
  - docs/hooks.py

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            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

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Installation: installation.md
  - User Guide:
      - Command Line Interface: cli.md
      - Enrichment Score Test: score_test.md
      - File Formats: file_formats.md
  - API Reference:
      - graphld: api/graphld.md
      - graphld.precision: api/precision.md
      - graphld.likelihood: api/likelihood.md
      - graphld.heritability: api/heritability.md
      - graphld.io: api/io.md
      - graphld.ldsc_io: api/ldsc_io.md
      - graphld.vcf_io: api/vcf_io.md
      - graphld.parquet_io: api/parquet_io.md
      - graphld.simulate: api/simulate.md
      - graphld.clumping: api/clumping.md
      - graphld.blup: api/blup.md
      - graphld.surrogates: api/surrogates.md
      - graphld.genesets: api/genesets.md
      - graphld.multiprocessing_template: api/multiprocessing.md
      - score_test: api/score_test.md
  - See Also: see_also.md