atomlib/mkdocs.yml at main · hexane360/atomlib · 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
site_name: atomlib Documentation
repo_url: https://github.com/hexane360/atomlib

docs_dir: 'docs'
site_dir: 'site'
extra_css:
  - style.css

nav:
  - Home: index.md
  - 'Using atomlib':
    - using/getting_started.md
    - using/coords.md
  - API:
    - api/index.md
    - api/atomcell.md
    - api/atoms.md
    - api/bbox.md
    - api/cell.md
    - api/defect.md
    - api/elem.md
    - api/expr.md
    - api/make.md
    - api/mixins.md
    - api/testing.md
    - api/transform.md
    - api/types.md
    - api/util.md
    - api/vec.md
    - api/visualize.md
    - atomlib.io:
      - api/io/index.md
      - api/io/cfg.md
      - api/io/cif.md
      - api/io/lmp.md
      - api/io/mp_api.md
      - api/io/mslice.md
      - api/io/qe.md
      - api/io/xsf.md
      - api/io/xyz.md

theme:
  name: material
  palette:
    primary: purple
    accent: green
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.indexes
  custom_dir: docs/templates
extra:
  version:
    provider: mike
extra_javascript:
  - javascript/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - markdown_include.include:
      base_path: docs

plugins:
  - search
  - autorefs
  - mkdocstrings:
      #custom_templates: templates
      handlers:
        python:
          paths: [.]
          import:
            # 3rd-party object inventories
            - https://docs.python.org/3/objects.inv

            - https://numpy.org/doc/stable/objects.inv
            - https://docs.scipy.org/doc/scipy/objects.inv
            - https://matplotlib.org/stable/objects.inv
            - https://docs.h5py.org/en/latest/objects.inv

            - https://arrow.apache.org/docs/objects.inv
            - https://pola-rs.github.io/polars/py-polars/html/objects.inv
          options:
            heading_level: 2
            docstring_section_style: "spacy"
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            show_if_no_docstring: true
            show_root_heading: false
            members_order: source
            filters: ["!^_", "!^__(all|repr|str)__$", "!^(HasAtoms|Transform3D|Num|AtomCell|HasAtomCell)?[TUKVP](_co(ntra)?)?$", "!^.*Self$"]
            inherited_members: true
  - mike:
      version_selector: true
      canonical_version: latest
     #alias_type: symlink

watch:
  - atomlib/
  - README.md