mkdocs.yml

site_name: OGC
repo_url: https://github.com/adam-stokes/ogc
plugins:
    - search
    - mkdocstrings:
        handlers:
            python:
                options:
                    show_source: true
                    show_bases: false
                    merge_init_into_class: true
                    show_signature_annotations: true
                    show_if_no_docstring: true
                    separate_signature: true
                    members_order: source    
    - macros
theme: 
    name: material
    palette:
        scheme: slate
        primary: green
    features:
        - navigation.instant
        - navigation.expand
        - navigation.top
        - toc.follow
        - content.code.copy
        - content.code.annotate
    font:
        text: Ubuntu
        code: Ubuntu Mono        
markdown_extensions:
    - toc:
        permalink: True
    - admonition
    - attr_list
    - def_list
    - md_in_html
    - meta
    - footnotes
    - abbr
    - markdown.extensions.codehilite:
        linenums: false
        guess_lang: false
        use_pygments: true
        noclasses: true
        pygments_style: monokai
    - pymdownx.arithmatex
    - pymdownx.betterem:
        smart_enable: all
    - pymdownx.caret
    - pymdownx.critic
    - pymdownx.details
    - pymdownx.emoji:
        emoji_generator: !!python/name:pymdownx.emoji.to_svg
    - pymdownx.highlight:
        anchor_linenums: true
    - pymdownx.inlinehilite
    - pymdownx.keys
    - pymdownx.magiclink:
        repo_url_shorthand: true
        user: adam-stokes
        repo: ogc
    - pymdownx.tabbed:
        alternate_style: true
    - pymdownx.mark
    - pymdownx.smartsymbols
    - pymdownx.superfences
    - pymdownx.tasklist:
        custom_checkbox: True
    - pymdownx.tilde
    - mkdocs-click
nav:
  - 'Getting Started': 'index.md'
  - 'User Guide':
    - "Configuration":
        - "Docker":
            - "SSH": 'user-guide/configuration/docker/ssh.md'
            - "Google Authentication": 'user-guide/configuration/docker/gcloud-auth.md'
    - 'Managing a deployment': 'user-guide/managing-nodes.md'
    - 'Defining Layouts': 'user-guide/defining-layouts.md'
    - 'Scripting': 'user-guide/scripting.md'
    - 'Providers': 'user-guide/providers.md'
    - 'Windows': 'user-guide/windows.md'
    - 'Cookbook':
        - 'Access node info': 'user-guide/cookbook/template-access-node-info.md'
  - 'Developer Guide':
    - 'Managing nodes': 'developer-guide/managing-nodes.md'
    - 'API':
        - 'ogc.deployer': 'developer-guide/api/deployer.md'
        - 'ogc.db': 'developer-guide/api/db.md'
        - 'ogc.fs': 'developer-guide/api/fs.md'
        - 'ogc.provision': 'developer-guide/api/provision.md'
        - 'ogc.templatetags': 'developer-guide/api/templatetags.md'
        - 'ogc.models.actions': 'developer-guide/api/models/actions.md'
        - 'ogc.models.machine': 'developer-guide/api/models/machine.md'
        - 'ogc.models.layout': 'developer-guide/api/models/layout.md'
        - 'ogc.models.tags': 'developer-guide/api/models/tags.md'
        - 'ogc.models.utils': 'developer-guide/api/models/utils.md'
  - 'CLI Reference': 'commands/ogc.md'