credtools/mkdocs.yml at main · Jianhua-Wang/credtools · 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
97
98
99
100
101
site_name: credtools
site_url: https://Jianhua-Wang.github.io/credtools
repo_url: https://github.com/Jianhua-Wang/credtools
repo_name: Jianhua-Wang/credtools
#strict: true
nav:
  - Home: index.md
  - Installation: installation.md
  - Usage: usage.md
  - Commands:
    - Munge: munge.md
    - Chunk: chunk.md
    - Meta-analysis: meta.md
    - Quality Control: qc.md
    - Fine-mapping: finemap.md
    - Pipeline: pipeline.md
  - Tutorial:
    - Overview: tutorial.md
    - Getting Started: tutorial/getting-started.md
    - Quick Start: tutorial/quick-start.md
    - Single-Input Fine-Mapping: tutorial/single-input.md
    - Multi-Input Fine-Mapping: tutorial/multi-input.md
    - Advanced Topics: tutorial/advanced.md
  - API:
    - credtools: API/credtools.md
    - utils: API/utils.md
    - locus: API/locus.md
    - ldmatrix: API/ldmatrix.md
    - meta: API/meta.md
    - qc: API/qc.md
    - sumstats: API/sumstats.md
    - credibleset: API/credibleset.md
    - cojo: API/cojo.md
  - Changelog: changelog.md
theme:
  name: material
  language: en
  #logo: assets/logo.png
  palette:
    scheme: preference
    primary: indigo
    accent: indigo
  features:
    - navigation.indexes
    - navigation.instant
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - toc.follow
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - admonition
  - toc:
      # baselevel: 2
      permalink: true
      # slugify: !!python/name:pymdownx.slugs.uslugify
  - meta
  - def_list
plugins:
  - include-markdown
  - search:
      lang: en
  - mkdocstrings:
      handlers:
      python:
        import:
        - https://docs.python.org/3/objects.inv
        - https://installer.readthedocs.io/en/stable/objects.inv  # demonstration purpose in the docs
        - https://mkdocstrings.github.io/autorefs/objects.inv
        options:
          docstring_style: numpy
          docstring_options:
            ignore_init_summary: yes
          merge_init_into_class: yes
          show_submodules: yes
      # watch:
      #   - mafm
extra:
  social:
  # to enable disqus, uncomment the following and put your disqus id below
  # disqus: disqus_id
# uncomment the following and put your google tracking id below to enable GA
#google_analytics:
  #- UA-xxx
  #- auto