161 lines
4.5 KiB
YAML
161 lines
4.5 KiB
YAML
site_name: Letzshop Import Documentation
|
|
site_description: Complete documentation for the Letzshop Import application
|
|
site_author: Letzshop Team
|
|
site_url: https://yourusername.github.io/letzshop-import/
|
|
|
|
repo_name: letzshop-import
|
|
repo_url: https://github.com/yourusername/letzshop-import
|
|
edit_uri: edit/main/docs/
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Installation: getting-started/installation.md
|
|
- Quick Start: getting-started/quickstart.md
|
|
- Database Setup: getting-started/database-setup.md # NEW
|
|
- Configuration: getting-started/configuration.md
|
|
- API:
|
|
- Overview: api/index.md
|
|
- Authentication: api/authentication.md
|
|
- Error Handling: api/error-handling.md
|
|
- Rate Limiting: api/rate-limiting.md
|
|
- User Guides:
|
|
- User Management: guides/user-management.md
|
|
- Product Management: guides/product-management.md
|
|
- Shop Setup: guides/shop-setup.md
|
|
- CSV Import: guides/csv-import.md
|
|
- Marketplace Integration: guides/marketplace-integration.md
|
|
- Testing:
|
|
- Testing Guide: testing/testing-guide.md
|
|
- Test Maintenance: testing/test-maintenance.md
|
|
- Development:
|
|
- Architecture: development/architecture.md
|
|
- Database Schema: development/database-schema.md
|
|
- Database Migrations: development/database-migrations.md # NEW
|
|
- Services: development/services.md
|
|
- Contributing: development/contributing.md
|
|
- Pycharm configuration: development/pycharm-configuration.md
|
|
- Pycharm configuration: development/exception-handling.md
|
|
- Pycharm configuration: development/frontend-exception-handling.md
|
|
- Synology repo: development/synology-github-repo.md
|
|
- Deployment:
|
|
- Overview: deployment/index.md
|
|
- Docker: deployment/docker.md
|
|
- Production: deployment/production.md
|
|
- Environment Variables: deployment/environment.md
|
|
|
|
# Theme configuration
|
|
theme:
|
|
name: material
|
|
palette:
|
|
# Palette toggle for automatic mode
|
|
- media: "(prefers-color-scheme)"
|
|
toggle:
|
|
icon: material/brightness-auto
|
|
name: Switch to light mode
|
|
|
|
# Palette toggle for light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: blue
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
|
|
# Palette toggle for dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: blue
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to system preference
|
|
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.path
|
|
- navigation.indexes
|
|
- toc.follow
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.tabs.link
|
|
- content.code.annotation
|
|
- content.code.copy
|
|
- content.action.edit
|
|
- content.action.view
|
|
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
# Plugins
|
|
plugins:
|
|
- search:
|
|
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
options:
|
|
docstring_style: google
|
|
show_source: true
|
|
show_root_heading: true
|
|
show_root_toc_entry: false
|
|
merge_init_into_class: true
|
|
|
|
# Markdown extensions
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.magiclink:
|
|
normalize_issue_symbols: true
|
|
repo_url_shorthand: true
|
|
user: yourusername
|
|
repo: letzshop-import
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
combine_header_slug: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
# Footer
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/yourusername
|
|
|
|
# Copyright
|
|
copyright: Copyright © 2024 Letzshop Team |