skyweaver/mkdocs.yml at main · amanchokshi/skyweaver · 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
site_name: skyweaver
site_description: Satellite sky track simulation

site_url: https://skyweaver.readthedocs.io/
repo_url: https://github.com/amanchokshi/skyweaver
repo_name: amanchokshi/skyweaver

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - content.code.copy
    - toc.integrate
  palette:
    - scheme: slate
      primary: teal
      accent: teal
  icon:
    logo: octicons/issue-opened-24
    repo: fontawesome/brands/github-alt
  favicon: imgs/favicon.ico

plugins:
  - gen-files:
      scripts:
        - docs/gen_api.py
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: numpy
            merge_init_into_class: true
            separate_signature: true
            show_source: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_if_no_docstring: false
  - mkdocs-jupyter:
      execute: false           # set true if you want to run cells on build
      allow_errors: false
      include_source: true     # show the notebook’s code cells
      ignore_h1_titles: true   # let MkDocs/MateriaI handle page titles
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - toc:
      permalink: true
      toc_depth: 2

watch:
  - src
  - docs

nav:
  - Home: index.md
  - Installation: guides/install.md
  - Getting Started:
    - guides/index.md
    - Skyweaver Tutorial: notebooks/skyweaver_tutorial.ipynb
  - API Reference:
    - api/index.md
    - skyweaver.observatories: api/skyweaver.observatories.md
    - skyweaver.timegrid: api/skyweaver.timegrid.md
    - skyweaver.orbits: api/skyweaver.orbits.md
    - skyweaver.tracks: api/skyweaver.tracks.md
    - skyweaver.viz.ground: api/skyweaver.viz.ground.md
    - skyweaver.viz.sky: api/skyweaver.viz.sky.md