mirror of
https://github.com/django-components/django-components.git
synced 2025-07-07 17:34:59 +00:00
ccf02fa316
* chore: util to manage URLs in the codebase * docs: mentiion validate_links and supported_versions in docs * refactor: fix linter errors
194 lines
5 KiB
YAML
194 lines
5 KiB
YAML
---
|
|
site_name: Django-Components
|
|
site_description: A way to create simple reusable template components in Django.
|
|
site_url: https://django-components.github.io/django-components/
|
|
|
|
repo_url: https://github.com/django-components/django-components
|
|
repo_name: django-components/django-components
|
|
edit_uri: https://github.com/django-components/django-components/edit/master/docs/
|
|
|
|
dev_addr: "127.0.0.1:9000"
|
|
site_dir: site
|
|
docs_dir: docs
|
|
|
|
watch:
|
|
- src
|
|
- docs
|
|
- mkdocs.yml
|
|
- README.md
|
|
- CHANGELOG.md
|
|
- scripts
|
|
|
|
validation:
|
|
absolute_links: warn
|
|
unrecognized_links: info
|
|
|
|
theme:
|
|
name: "material"
|
|
# Uncomment to extend / override files from the theme
|
|
# custom_dir: docs/overrides
|
|
features:
|
|
- content.action.edit
|
|
- content.action.view
|
|
- content.code.annotate
|
|
- content.code.copy
|
|
- content.tabs.link
|
|
- navigation.expand
|
|
- navigation.footer
|
|
- navigation.instant
|
|
- navigation.instant.progress
|
|
- navigation.indexes
|
|
- navigation.sections
|
|
- navigation.tabs
|
|
- navigation.tracking
|
|
- navigation.top
|
|
- search.highlight
|
|
- search.share
|
|
- search.suggest
|
|
- toc.follow
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
palette:
|
|
- media: "(prefers-color-scheme)"
|
|
toggle:
|
|
icon: material/brightness-auto
|
|
name: Switch to light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: teal
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: teal
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
|
|
extra_css:
|
|
- css/style.css
|
|
|
|
extra:
|
|
version:
|
|
provider: mike
|
|
default:
|
|
- dev
|
|
alias: true
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/django-components/django-components
|
|
- icon: fontawesome/brands/python
|
|
link: https://pypi.org/project/django-components/
|
|
|
|
markdown_extensions:
|
|
abbr: {}
|
|
admonition: {}
|
|
attr_list: {}
|
|
codehilite: {}
|
|
def_list: {}
|
|
tables: {}
|
|
md_in_html: {}
|
|
# mdx_truly_sane_lists: {}
|
|
pymdownx.magiclink:
|
|
repo_url_shorthand: true
|
|
user: django-components
|
|
repo: django-components
|
|
pymdownx.details: {}
|
|
pymdownx.highlight:
|
|
anchor_linenums: true
|
|
pymdownx.inlinehilite: {}
|
|
pymdownx.snippets:
|
|
check_paths: true
|
|
base_path: .
|
|
pymdownx.tabbed:
|
|
alternate_style: true
|
|
pymdownx.superfences:
|
|
pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
toc:
|
|
permalink: "¤"
|
|
|
|
|
|
plugins:
|
|
- autorefs
|
|
- include-markdown:
|
|
# Default is django style...
|
|
opening_tag: "{!"
|
|
closing_tag: "!}"
|
|
- gen-files:
|
|
scripts:
|
|
- docs/scripts/setup.py
|
|
- docs/scripts/reference.py
|
|
- awesome-nav
|
|
- git-revision-date-localized:
|
|
enabled: !ENV [CI, false]
|
|
type: timeago
|
|
exclude:
|
|
- reference/*
|
|
- changelog.md
|
|
- code_of_conduct.md
|
|
- license.md
|
|
- git-authors:
|
|
enabled: !ENV [CI, false]
|
|
exclude:
|
|
- reference/*
|
|
- changelog.md
|
|
- code_of_conduct.md
|
|
- license.md
|
|
- markdown-exec
|
|
# - toc-md:
|
|
- search
|
|
- social:
|
|
enabled: !ENV [CI, false]
|
|
- mike:
|
|
canonical_version: "latest"
|
|
version_selector: true
|
|
- redirects:
|
|
redirect_maps:
|
|
# 'old.md': 'new.md'
|
|
'README.md': 'overview/welcome.md'
|
|
- minify:
|
|
minify_html: true
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
import:
|
|
- https://docs.python.org/3.12/objects.inv
|
|
- url: https://docs.djangoproject.com/en/5.2/_objects/
|
|
base: https://docs.djangoproject.com/en/5.2/
|
|
domains: [std, py]
|
|
paths: [src] # search packages in the src folder
|
|
options:
|
|
docstring_options:
|
|
ignore_init_summary: true
|
|
docstring_section_style: list
|
|
filters: ["!^_"]
|
|
group_by_category: true
|
|
heading_level: 2
|
|
inherited_members: true
|
|
merge_init_into_class: true
|
|
preload_modules: [mkdocstrings]
|
|
separate_signature: true
|
|
show_root_heading: true
|
|
show_root_full_path: false
|
|
show_signature_annotations: true
|
|
show_symbol_type_heading: true
|
|
show_symbol_type_toc: true
|
|
signature_crossrefs: true
|
|
summary: true
|
|
unwrap_annotated: true
|
|
show_if_no_docstring: false
|
|
line_length: 140
|
|
show_submodules: true
|
|
docstring_style: google
|
|
show_bases: false # NOTE: Instead we use RuntimeBasesExtension
|
|
show_source: false # NOTE: Instead we use SourceCodeExtension
|
|
# NOTE: Order matters!
|
|
extensions:
|
|
- docs/scripts/extensions.py:RuntimeBasesExtension
|
|
- docs/scripts/extensions.py:SourceCodeExtension
|
|
# - docs/scripts/extensions.py:ComponentSyntaxesExtension
|