Python-Starting-Project/mkdocs.yml at main · dhkts1/Python-Starting-Project · 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
136
137
138
139
site_name: Python Starting Project
site_description: A comprehensive Python project template with built-in logging, configuration management, and development tools
site_author: Gil Portnoy
repo_url: https://github.com/dhkts1/Python-Starting-Project
repo_name: python-starting-project

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - 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

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
  - include-markdown

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.critic
  - admonition
  - pymdownx.details
  - pymdownx.emoji
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/yourusername/python-starting-project

nav:
  - Home: index.md
  - Why This Project: why.md
  - Learning Path:
    - Overview: learning-path/index.md
    - Beginner's Guide: learning-path/beginners-guide.md
    - Intermediate Topics: learning-path/intermediate-topics.md
    - Advanced Techniques: learning-path/advanced-techniques.md
  - Tutorials:
    - Overview: tutorials/index.md
    - Setup Your First Project: tutorials/setup-your-first-project.md
    - Adding a Feature: tutorials/adding-a-feature.md
    - Testing Your Code: tutorials/testing-your-code.md
  - Tools Guide:
    - Overview: tools-guide/index.md
    - Code Quality: tools-guide/code-quality.md
    - Documentation: tools-guide/documentation.md
    - Testing: tools-guide/testing.md
    - Project Management: tools-guide/project-management.md
  - Getting Started: getting-started.md
  - Architecture:
    - Overview: architecture/index.md
    - Configuration: architecture/configuration.md
    - Logging: architecture/logging.md
    - IDE Setup: architecture/ide-setup.md
    - Lazy Loading: architecture/lazy-loading.md
  - Development:
    - Overview: development/index.md
    - Pre-commit Hooks: development/pre-commit-hooks.md
    - Workflow: development/workflow.md
    - Simplified Workflow: development/simplified-workflow.md
  - Technologies:
    - Overview: technologies/index.md
    - Code Analysis:
      - Bandit: technologies/code-analysis/bandit.md
      - Pyright: technologies/code-analysis/pyright.md
      - ShellCheck-py: technologies/code-analysis/shellcheck-py.md
      - Vulture: technologies/code-analysis/vulture.md
    - Code Quality:
      - Codespell: technologies/code-quality/codespell.md
      - Commitizen: technologies/code-quality/commitizen.md
      - Darglint: technologies/code-quality/darglint.md
      - Flynt: technologies/code-quality/flynt.md
      - Interrogate: technologies/code-quality/interrogate.md
      - MDFormat: technologies/code-quality/mdformat.md
      - MkInit: technologies/code-quality/mkinit.md
      - PyUpgrade: technologies/code-quality/pyupgrade.md
      - Radon: technologies/code-quality/radon.md
      - Ruff: technologies/code-quality/ruff.md
      - Xenon: technologies/code-quality/xenon.md
    - Documentation:
      - Overview: technologies/documentation/index.md
      - MkDocs: technologies/documentation/mkdocs.md
      - MkDocstrings: technologies/documentation/mkdocstrings.md
    - Package Management:
      - Hatchling: technologies/package-management/hatchling.md
      - UV: technologies/package-management/uv.md
    - Project Structure:
      - Hatchling: technologies/project-structure/hatchling.md
      - Lazy Loader: technologies/project-structure/lazy-loader.md
      - MkInit: technologies/project-structure/mkinit.md
      - Pydantic Settings: technologies/project-structure/pydantic-settings.md
    - Task Running:
      - Poethepoet: technologies/task-running/poethepoet.md
    - Testing:
      - Pytest: technologies/testing/pytest.md
      - Pytest-AsyncIO: technologies/testing/pytest-asyncio.md
      - Pytest-Cov: technologies/testing/pytest-cov.md
      - Pytest-XDist: technologies/testing/pytest-xdist.md
    - Version Control:
      - Git: technologies/version-control/git.md
      - Pre-commit: technologies/version-control/pre-commit.md
  - API Reference: api/index.md