cluv/mkdocs.yaml at master · mila-iqia/cluv · 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
site_name: Cluv Documentation
repo_name: mila-iqia/cluv
repo_url: https://github.com/mila-iqia/cluv
docs_dir: docs
edit_uri: edit/master/docs/

nav:
  - Home: index.md
  - Hydra launcher: hydra-launcher.md
  - Commands: commands.md
  - Guides:
      - Introduction: guides/introduction.md
      - Syncing datasets: guides/syncing-datasets.md
      - Configuring job submission: guides/submit-config.md
      - Cleaning runs: guides/cleaning-runs.md
  - Reference:
      - CLI:
          - init: reference/cli/init.md
          - login: reference/cli/login.md
          - run: reference/cli/run.md
          - submit: reference/cli/submit.md
          - status: reference/cli/status.md
          - sync: reference/cli/sync.md
      - Config: reference/config.md
      - Remote: reference/remote.md

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.action.edit
    - content.action.view
    - navigation.expand
    - content.code.copy
    - content.code.annotate
    - navigation.sections
    - navigation.path
    - search.share
    - search.suggest
    - search.highlight
  icon:
    repo: fontawesome/brands/github
markdown_extensions:
  - pymdownx.highlight: # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#configuration
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.magiclink
  - admonition
  - pymdownx.details
  # For annotations https://squidfunk.github.io/mkdocs-material/reference/annotations/?h=annota#annotations
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.pytest.org/en/stable/objects.inv
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: google
            members_order: source
            annotations_path: brief
            show_docstring_attributes: true
            modernize_annotations: true
            show_source: false
            show_submodules: false
            separate_signature: true
            signature_crossrefs: true
            show_signature_annotations: true
            allow_inspection: true
            backlinks: tree
            show_labels: false