universal_pathlib/mkdocs.yml at main · fsspec/universal_pathlib · 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
site_name: Universal Pathlib
site_description: A universal pathlib implementation for Python
strict: true
# site_url: !ENV READTHEDOCS_CANONICAL_URL

theme:
  name: 'material'
  logo: assets/logo-128x128-white.svg
  favicon: 'assets/favicon.png'
  palette:
  - media: "(prefers-color-scheme: light)"
    toggle:
      icon: material/lightbulb-outline
      name: "Switch to dark mode"
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    toggle:
      icon: material/lightbulb
      name: "Switch to light mode"
  features:
    # - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - announce.dismiss
    - navigation.tabs

extra_css:
  - css/extra.css

repo_name: fsspec/universal_pathlib
repo_url: https://github.com/fsspec/universal_pathlib
edit_uri: edit/main/docs/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
  - Home:
    - Introduction: index.md
    - Why use Universal Pathlib: why.md
    - Installation: install.md
    - Contributing: contributing.md
    - Changelog: changelog.md
  - Concepts:
    - Overview: concepts/index.md
    - Filesystem Spec: concepts/fsspec.md
    - Standard Library Pathlib: concepts/pathlib.md
    - Universal Pathlib: concepts/upath.md
  - Usage:
    - Basic Usage: usage.md
  - API Reference:
    - Core: api/index.md
    - Registry: api/registry.md
    - Implementations: api/implementations.md
    - Extensions: api/extensions.md
    - Types: api/types.md
  - Migration Guide: migration.md

markdown_extensions:
- tables
- attr_list
- toc:
    permalink: true
    title: Page contents
- admonition
- pymdownx.details
- pymdownx.highlight:
    pygments_lang_class: true
- pymdownx.extra
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tasklist:
    custom_checkbox: true
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format

watch:
  - docs/
  - upath/

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        inventories:
          - https://docs.python.org/3/objects.inv
        paths: [.]
        options:
          preload_modules:
            - __future__
            - typing
            - abc
            - asyncio
            - pathlib
            - pathlib_abc
            - fsspec
            - upath.types._abc
            - upath.types
            - upath.registry
            - upath.core
          docstring_style: numpy
          docstring_section_style: list
          group_by_category: false
          members_order: source
          docstring_options:
            ignore_init_summary: true
          docstring_section_style: spacy
          merge_init_into_class: true
          show_source: true
          show_root_heading: true
          show_root_toc_entry: true
          allow_inspection: true
          separate_signature: true
          show_signature: true
          show_signature_annotations: true
          show_signature_type_parameters: true
          signature_crossrefs: true
          show_symbol_type_heading: true
- exclude:
    glob:
      - _plugins/*
      - __pycache__/*
      - tests/*
      - test_*.py
hooks:
  - docs/_plugins/copy_changelog.py