cornucopia/mkdocs.yml at main · balbasty/cornucopia · 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
site_name: cornucopia
site_url: https://cornucopia.readthedocs.io
repo_url: https://github.com/balbasty/cornucopia
edit_uri: blob/main/docs
site_dir: html
docs_dir: docs
theme:
  name: material
  palette:
    primary: orange
    accent: orange
  icon:
    repo: fontawesome/brands/github
  logo:
    icons/cc_full_white.svg
extra_css:
  - stylesheets/extra.css
plugins:
- mkdocs-jupyter
- mkdocstrings:
    handlers:
      python:
        paths: [..]
        options:
          docstring_style: numpy
          merge_init_into_class: True
          separate_signature: True
          members_order: source
          show_source: False
          show_root_heading: True
          show_overloads: true
          overloads_only: true
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.arithmatex:
    generic: true
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
- Home: index.md
- Installation: install.md
- Getting Started: start.md
- Examples:
  -  Overview: examples/overview.md
  -  Field-of-view transforms: examples/fov.ipynb
  -  Noise transforms: examples/noise.ipynb
  -  Geometric transforms: examples/geom.ipynb
  -  Random intra-scan motion: examples/motion.ipynb
  -  Contrast augmentation: examples/contrast.ipynb
  -  Label augmentation: examples/labels.ipynb
  -  Synthetic MRIs: examples/synth.ipynb
  -  Quantitative MRIs: examples/qmri.ipynb
  -  Random coil sensitivities: examples/coils.ipynb
  -  Benchmark: examples/benchmark.ipynb
- API:
  - overview: api/overview.md
  - base: api/base.md
  - contrast: api/contrast.md
  - ctx: api/ctx.md
  - fov: api/fov.md
  - geometric: api/geometric.md
  - intensity: api/intensity.md
  - io: api/io.md
  - kspace: api/kspace.md
  - labels: api/labels.md
  - noise: api/noise.md
  - psf: api/psf.md
  - qmri: api/qmri.md
  - random: api/random.md
  - special: api/special.md
  - synth: api/synth.md

watch:
- cornucopia