Epymorph/mkdocs.yml at main · NAU-CCL/Epymorph · 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
# The mkdocs configuration for epymorph's API documentation.

site_name: epymorph
site_url: https://docs.www.epimorph.org/api/latest
repo_url: https://github.com/NAU-CCL/Epymorph

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/NAU-CCL/Epymorph/
      name: epymorph on Github
  version:
    provider: mike
    alias: true

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - content.code.annotate
  custom_dir: docs/overrides

extra_css:
  - styles.css
extra_javascript:
  - scripts.js

watch:
  - docs
  - epymorph
  - mkdocs.yml

exclude_docs: |
  _examples/

validation:
  links:
    absolute_links: ignore

plugins:
  search:
  gen-files:
    scripts:
      - scripts/mkdocs_generate_api_pages.py
  mkdocstrings:
    enable_inventory: true
    handlers:
      python:
        paths: [.]
        inventories:
          - https://docs.python.org/3.11/objects.inv
          - https://numpy.org/doc/1.26/objects.inv
          - https://docs.sympy.org/latest/objects.inv
          - https://pandas.pydata.org/pandas-docs/version/2.2/objects.inv
          - https://geopandas.org/en/v0.14.4/objects.inv
          - https://matplotlib.org/3.9.3/objects.inv
          - https://shapely.readthedocs.io/en/2.0.6/objects.inv

        options:
          docstring_style: numpy
          docstring_section_style: list
          docstring_options:
            ignore_init_summary: true
          merge_init_into_class: true
          show_source: false
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          show_if_no_docstring: true
          show_overloads: false
          show_signature_annotations: true
          separate_signature: true
          signature_crossrefs: true
          inherited_members: false
          members_order: [__all__, source]
          filters:
            - "!^_"
            - "^__init__$"
            - "^__iter__$"
            - "^__call__$"
          extensions:
            - griffe_inherited_docstrings

markdown_extensions:
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.highlight:
      linenums: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true