predspot/mkdocs.yml at master · adaj/predspot · 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
site_name: Predspot
site_description: Predicting crime hotspots with machine learning
site_url: https://adaj.github.io/predspot/
repo_url: https://github.com/adaj/predspot
repo_name: adaj/predspot
edit_uri: edit/master/docs/
copyright: Copyright &copy; 2019-2026 Adelson Araujo &mdash; BSD-3-Clause

theme:
  name: material
  language: en
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow

nav:
  - Home: index.md
  - Getting started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - User guide:
      - How Predspot works: guide/concepts.md
      - Data and study areas: guide/data.md
      - Grids and spatio-temporal mapping: guide/mapping.md
      - Feature engineering: guide/features.md
      - Prediction and evaluation: guide/modelling.md
  - Examples:
      - Natal, Brazil (end to end): examples/natal.ipynb
  - API reference:
      - predspot: api/predspot.md
      - dataset_preparation: api/dataset_preparation.md
      - crime_mapping: api/crime_mapping.md
      - feature_engineering: api/feature_engineering.md
      - ml_modelling: api/ml_modelling.md
      - synthetic: api/synthetic.md
      - pipeline: api/pipeline.md
      - utilities: api/utilities.md
  - Project:
      - Changelog: changelog.md
      - Contributing: contributing.md
      - Citing Predspot: citing.md

hooks:
  - docs/hooks/readme.py

plugins:
  - search
  - mkdocs-jupyter:
      execute: false
      include_source: true
      include_requirejs: true
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_options:
              returns_named_value: false
              returns_multiple_items: false
              ignore_init_summary: true
            docstring_section_style: table
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            separate_signature: true
            show_signature_annotations: false
            merge_init_into_class: true
            filters: ["!^_"]

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
      base_path: [".", "docs"]
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/adaj/predspot
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/predspot/