sdata/mkdocs.yml at master · lepy/sdata · 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
site_name: sdata
site_description: a structured data format — self-describing, machine-readable data
site_url: https://lepy.github.io/sdata/
repo_url: https://github.com/lepy/sdata
repo_name: lepy/sdata
edit_uri: edit/master/docs/
copyright: MIT License

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.instant
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Light mode

exclude_docs: |
  requirements.txt
  build/

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx
            show_root_heading: true
            show_root_full_path: false
            show_source: false
            members_order: source
            separate_signature: true
            filters: ["!^_"]

markdown_extensions:
  - admonition
  - attr_list
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets

nav:
  - Home: index.md
  - Usage:
      - Cookbook (end to end): usage/cookbook.md
      - Tabular data (DataFrame): usage/dataframe.md
      - Writing DataFrames (writers): usage/writer.md
      - Image metadata: usage/image-metadata.md
      - Machine-readable metadata: usage/metadata-jsonld.md
  - API reference: api.md
  - Conventions: conventions.md
  - RFCs:
      - "0001 — json1sqlitestore index naming": rfc/0001-json1sqlitestore-index-naming.md
      - "0002 — HDF5 DataFrame serialization": rfc/0002-hdf5-dataframe-serialization.md
      - "0003 — Blob as data foundation": rfc/0003-blob-as-data-foundation.md
      - "0004 — DataFrame and Blob": rfc/0004-dataframe-and-blob.md
      - "0005 — Native image metadata": rfc/0005-native-image-metadata.md
      - "0006 — Consistent unit systems (dimensional algebra)": rfc/0006-unit-system-conversion-on-set.md
      - "0007 — DataFrame writer interface": rfc/0007-dataframe-writer-interface.md
      - "0008 — Bestandsaufnahme und Roadmap": rfc/0008-bestandsaufnahme-roadmap.md
      - "0008 — Umsetzungsstand": rfc/0008-umsetzung.md
      - "0009 — DataFrame reader interface": rfc/0009-dataframe-reader-interface.md
      - "0010 — Format versioning": rfc/0010-format-versioning.md
      - "0011 — Persistence consolidation": rfc/0011-persistence-consolidation.md
      - "0012 — Data deprecation": rfc/0012-data-deprecation.md
      - "0013 — Packaging modernization": rfc/0013-packaging-modernization.md
      - "0014 — Unit system persistence": rfc/0014-unit-system-persistence.md
      - "Open points (backlog)": rfc/open-points.md
  - Releasing: releasing.md
  - Changelog: changelog.md