fastapi-shield/mkdocs.yaml at main · jymchng/fastapi-shield · 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
site_name: fastapi-shield
site_description: Shield is a FastAPI decorator that provides a simple shield for your API Endpoints to shield off unwanted requests.
site_author: Jim Chng
repo_url: https://github.com/jymchng/fastapi-shield
repo_name: jymchng/fastapi-shield

theme:
  name: material
  logo: logo-shield-only.png
  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 Done
      - Basic Usage: user-guide/basic-usage.md
      # Authentication Patterns Done
      - Authentication Patterns: user-guide/authentication-patterns.md
      # Custom Initialization Done
      - Custom Initialization: user-guide/custom-initialization.md
      # String Types Done
      - String Types: user-guide/string-types.md
      # Request Validation Done
      - Request Validation: user-guide/request-validation.md
      # Comparison with Alternatives Done
      - Comparison with Alternatives: user-guide/comparison_alternatives.md
  - Examples:
      # Basic Examples Done
      - Basic Examples: examples/basic_examples.md
      # Authentication Examples Done
      - Authentication Examples: examples/authentication_examples.md
      # Advanced Examples Done
      - Advanced Examples: examples/advanced_examples.md
      # Real World Examples Done
      - Real World Examples: examples/real_world.md
      # Using with Pydantic Done
      - Using with Pydantic: examples/using_with_pydantic.md
  - Advanced Topics:
      # JWT Authentication Done
      - JWT Authentication: advanced-topics/jwt-authentication.md
      # Dependency Injection Done
      - Dependency Injection: advanced-topics/dependency-injection.md
      # Method Interception Done
      - Method Interception: advanced-topics/method-interception.md
      # Security Best Practices Done
      - Security Best Practices: advanced-topics/security-best-practices.md
  - API Reference:
      - Overview: api/index.md
      - Core Components:
        - Shield: api/shield.md
        - ShieldDepends: api/shield-depends.md
        - shield (factory): api/shield-factory.md
        - ShieldedDepends (factory): api/shielded-depends-factory.md
      - Utilities:
        - Utils: api/utils.md
        - OpenAPI Integration: api/openapi.md
        - Type Definitions: api/typing.md
        - Constants: api/constants.md
  - Development:
      - Overview: development/index.md
      - Contributing: development/contributing.md
      - Building: development/building.md
      - Testing: development/testing.md
      - Architecture: development/architecture.md
      - Roadmap: development/roadmap.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
            extra:
              paths:
                - '**/*.pyi'
                - '!**/*.so'  # Exclude .so files
                - '!**/*.pyd'  # Exclude .pyd files