python-newtype-dev/mkdocs.yml at main · jymchng/python-newtype-dev · 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
site_name: python-newtype
site_description: A Python library for extending existing types with additional functionality
site_author: openhands
repo_url: https://github.com/jymchng/python-newtype-dev
repo_name: jymchng/python-newtype-dev

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - User Guide:
    - Basic Usage: user-guide/basic-usage.md
    - Type Wrapping: user-guide/type-wrapping.md
    - Method Interception: user-guide/method-interception.md
    - Custom Initialization: user-guide/custom-initialization.md
    - String Types: user-guide/string-types.md
    - Examples: user-guide/examples.md
  - Examples:
    - Basic Examples: examples/basic_examples.md
    - Advanced Examples: examples/advanced_examples.md
    - Real World Examples: examples/real_world.md
    - Using with Pydantic: examples/using_with_pydantic.md
  - Advanced Topics:
    - Type Inheritance: advanced-topics/type-inheritance.md
    - Method Interception: advanced-topics/method-interception.md
  - API Reference:
    - NewType: api/newtype.md
  - Development:
    - Contributing: development/contributing.md
    - Building: development/building.md
    - Testing: development/testing.md
    - Performance: development/performance.md

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

plugins:
  - search
  - tags
  - mkdocstrings:
      handlers:
        python:
          options:
            show_bases: true
            find_stubs_package: true
            allow_inspection: false # to remove __file__ etc from c extension stubs
          source:
            - '**/*.pyi'
            - '!**/*.so'  # Exclude .so files
            - '!**/*.pyd'  # Exclude .so files