rlcms/mkdocs.yml at main · sig-gis/rlcms · 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
site_name: RLCMS Documentation
nav:
  - Home: index.md
  - About: about.md
  - Command Line Tools: cli.md
  - Colab Notebooks:
    - compositing: colab\compositing.md
    - primitives: colab\primitives.md
    - sampling: colab\sampling.md
  - API Reference:
    - composites module: composites.md
    - covariates module: covariates.md
    - harmonics module: harmonics.md
    - primitives module: primitives.md
    - sampling module: sampling.md
    - utils module: utils.md

theme:
  name: material
  favicon: img/rlcms_logo_darkblue_fill.png # thumbnail of broswer tab
  logo: img/rlcms_logo.png # what appears in header of site
  palette:
    primary: custom
  features:
    - navigation.footer

extra_css:
  - stylesheets/extra.css

plugins:
- search
- mkdocstrings:
    enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
    custom_templates: templates
    default_handler: python
    handlers:
      python:
        options:
          show_source: false

repo_url: https://github.com/sig-gis/rlcms
repo_name: sig-gis/rlcms

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/sig-gis/rlcms
  # pypi
  # social:
  #   - icon: fontawesome/brands/pypi
  #     link: https://pypi.org/project/rlcms/