File: mkdocs.yml

package info (click to toggle)
cctools 1%3A7.15.9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 40,008 kB
  • sloc: ansic: 117,215; python: 30,569; cpp: 20,301; sh: 13,834; perl: 4,056; xml: 3,688; makefile: 1,502
file content (56 lines) | stat: -rw-r--r-- 1,801 bytes parent folder | download | duplicates (2)
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
# mkdocs configuration file for building the manual for readthedocs

site_name: CCTools Documentation
site_url: https://cctools.readthedocs.io/en/latest
site_author: Cooperative Computing Lab at the University of Notre Dame
copyright: Copyright (C) 2022 The University of Notre Dame

nav:
    - Getting Started:
        - About: 'about.md'
        - Installation: 'install/index.md'
        - Getting Help: 'help.md'
    - Software:
        - TaskVine: 'taskvine/index.md'
        - Work Queue: 'work_queue/index.md' 
        - Makeflow: 'makeflow/index.md'
        - Resource Monitor: 'resource_monitor/index.md'
        - JX Workflow Language: 'jx-workflow/index.md'
        - JX Expressions: 'jx/index.md'
        - Parrot: 'parrot/index.md'
        - Chirp: 'chirp/index.md'
        - Catalog Server: 'catalog/index.md'
        - Poncho: 'poncho/index.md'
    - Research Prototypes:
        - AWE: 'awe/index.md'
        - Confuga: 'confuga/index.md'
        - Umbrella: 'umbrella/index.md'
        - Prune: 'prune/index.md'
    - Reference:
        - Man Pages: 'man_pages.md'
        - Network Configuration: 'network/index.md'
        - JX Expression Language: 'jx/index.md'
        - Chirp Reference: 'chirp/chirp_protocol.md'
        - API Reference: 'api/html/index.html'

extra_css:
    - css/tabs.css

markdown_extensions:
    - toc:
    - admonition:
    - pymdownx.tabbed:
    - pymdownx.superfences:
    - pymdownx.snippets:
        base_path: ['doc/manuals']   # make snippets relative to manual root
        restrict_base_path: false    # allow snippets to include examples outside of that tree
        check_paths: true            # fail if snippet include doesn't work

validation:
    nav:
        omitted_files: ignore

docs_dir: manuals
site_dir: mkdocs-site

theme: readthedocs