maestrowf/mkdocs.yml at develop · llnl/maestrowf · 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
site_name: Maestro Workflow Conductor
use_directory_urls: false
markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - md_in_html
  - pymdownx.snippets:
      base_path: ['.']
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true

plugins:
    - search
    - mkdocstrings:
        handlers:
          python:
            paths: [..]
            options:
              docstring_style: sphinx

    - gen-files:
        scripts:
          - docs/gen_api_docs.py
          - docs/gen_changelog.py
          - docs/gen_contributing.py
          - docs/gen_release.py
    - literate-nav:
        nav_file: SUMMARY.md
    - glightbox
    - termynal:
        title: bash
        prompt_literal_start:
          - "$"
          - ">"
    # - section-index

extra_javascript:
    - https://unpkg.com/mermaid@10.9.3/dist/mermaid.min.js

extra_css:
  - custom.css

theme:
  name: material
  logo: assets/logo2.png
  features:
    - header.autohide
    - navigation.tabs.sticky
    - navigation.tabs
    # - navigation.expand
    - navigation.instant
    - navigation.indexes
    # - toc.integrate
    - content.code.annotate
    - content.code.copy
  palette:
    - scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to light mode

  custom_dir: docs/overrides
nav:
    # - 'index2.md'
    - Maestro: 'index.md'
    - Philosophy:
        - Background: "Philosophy/index.md"
        - How are Workflows Represented?: "Philosophy/representation.md"
        - Principles: "Philosophy/principles.md"
    - User Guide:
        - Overview: 'Maestro/index.md'
        - Installation: 'Maestro/install.md'
        - Tutorials: 'Maestro/tutorials.md'
        - Monitoring Studies: 'Maestro/monitoring.md'
        - Command Line Interface: 'Maestro/cli.md'
        - Specification:
            - Specification 1.0: 'Maestro/specification.md'
            - Scheduling Studies: 'Maestro/scheduling.md'
        - Specifying Study Parameters: 'Maestro/parameter_specification.md'
        - Study Workspaces: 'Maestro/study_workspaces.md'
        - How-to Guides:
            - 'Maestro/how_to_guides/index.md'
            - 'Maestro/how_to_guides/timeouts.md'
            - 'Maestro/how_to_guides/controlling_step_states.md'
            - 'Maestro/how_to_guides/parameter_batches.md'
            - 'Maestro/how_to_guides/running_with_flux.md'
    - Reference Guide:
        - Maestro Reference: Maestro/reference_guide/index.md
        - Design Reference: Maestro/reference_guide/design_reference/
        - API Reference: Maestro/reference_guide/api_reference/
    - What's New:
        - Overview: whats_new/index.md
        - Changelog: whats_new/changelog.md
        - Contributing: whats_new/contributing.md
        - Release Process: whats_new/release.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/LLNL/maestrowf
      name: Maestro on GitHub


watch:                          # NOTE: This doesn't seem to work?
  - CHANGELOG.md
  # - CHANGELOG_docs.md    # Turn off as this doesn't always exist, which mkdocs doesn't like
  - changelog.d
  - scriv_docs.ini
  - CONTRIBUTING.md

copyright: Copyright &copy; 2017 | Francesco Di Natale; Copyright &copy; 2023 | Francesco Di Natale, Jeremy White