Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 43 additions & 2 deletions docs/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ extra:
- icon: fontawesome/brands/discord
link: https://beeware.org/bee/chat/
name: BeeWare on Discord
generator: false

theme:
name: material
Expand All @@ -58,6 +59,8 @@ theme:
- toc.follow
- navigation.indexes
- navigation.footer
- navigation.tabs
- navigation.tabs.sticky
- search.suggest
- search.highlight
- search.share
Expand All @@ -84,20 +87,58 @@ theme:
name: Switch to system preference

markdown_extensions:
# PyMdown Extensions
pymdownx.highlight: {}
pymdownx.superfences: {}
pymdownx.blocks.admonition: {}
pymdownx.blocks.caption: {}
pymdownx.blocks.admonition: # Enables admonitions.
types:
- note
- abstract
- info
- tip
- success
- question
- warning
- failure
- danger
- bug
- example
- quote
pymdownx.blocks.details: # Enables collapsible content.
types:
- {name: details-note, class: note}
- {name: details-abstract, class: abstract}
- {name: details-info, class: info}
- {name: details-tip, class: tip}
- {name: details-success, class: success}
- {name: details-question, class: question}
- {name: details-warning, class: warning}
- {name: details-failure, class: failure}
- {name: details-danger, class: danger}
- {name: details-bug, class: bug}
- {name: details-example, class: example}
- {name: details-quote, class: quote}
pymdownx.blocks.tab:
alternate_style: true
pymdownx.magiclink: # Among other things, enables GitHub shorthand references.
provider: "github"
user: "beeware"
repo: "toga"
repo_url_shortener: true
repo_url_shorthand: true
normalize_issue_symbols: true
pymdownx.snippets:
base_path: ["docs"]
url_download: true
check_paths: true
# Python Markdown Extensions
attr_list: {}
smarty: # Enables easy em and en dashes.
smart_quotes: false
toc:
permalink: true
title: On this page
attr_list: {}

plugins:
search: {}
Expand Down
8 changes: 8 additions & 0 deletions docs/mkdocs.de.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@ theme:

extra:
translation_type: machine
language_url: de/
header:
About: Über
Documentation: Dokumentation
Community: Verbund
Contributing: Mithelfen
News: Neuigkeiten
Sponsor: Fördern
1 change: 1 addition & 0 deletions docs/mkdocs.en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ docs_dir: en

extra:
translation_type: original
header: {}
8 changes: 8 additions & 0 deletions docs/mkdocs.es.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@ theme:

extra:
translation_type: machine
language_url: es/
header:
About: Acerca
Documentation: Documentación
Community: Comunidad
Contributing: Contribuir
News: Noticias
Sponsor: Auspiciar
8 changes: 8 additions & 0 deletions docs/mkdocs.fr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@ theme:

extra:
translation_type: machine
language_url: fr/
header:
About: À Propos
Documentation: Documentation
Community: Communauté
Contributing: Contribuer
News: Nouvelles
Sponsor: Parrainer
8 changes: 8 additions & 0 deletions docs/mkdocs.it.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@ theme:

extra:
translation_type: machine
language_url: it/
header:
About: Circa
Documentation: Documentazione
Community: Comunità
Contributing: Contribuire
News: Notizie
Sponsor: Sponsorizzare
8 changes: 8 additions & 0 deletions docs/mkdocs.pt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@ theme:

extra:
translation_type: machine
language_url: pt/
header:
About: Sobre
Documentation: Documentação
Community: Comunidade
Contributing: Contribuir
News: News
Sponsor: Patrocinar
10 changes: 9 additions & 1 deletion docs/mkdocs.zh_CN.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
INHERIT: config.yml
site_name: BeeWare Tutorial
site_url: https://tutorial.beeware.org/zh_CN
site_url: https://tutorial.beeware.org/zh-cn
docs_dir: zh_CN

theme:
language: zh

extra:
translation_type: machine
language_url: zh-cn/
header:
About: 关于
Documentation: 文档
Community: 社区
Contributing: 贡献
News: 新闻
Sponsor: 赞助
10 changes: 9 additions & 1 deletion docs/mkdocs.zh_TW.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
INHERIT: config.yml
site_name: BeeWare Tutorial
site_url: https://tutorial.beeware.org/zh_TW
site_url: https://tutorial.beeware.org/zh-tw
docs_dir: zh_TW

theme:
language: zh-TW

extra:
translation_type: machine
language_url: zh-tw/
header:
About: 關於
Documentation: 文件
Community: 社群
Contributing: 貢獻
News: 新聞
Sponsor: 贊助
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ translate = [
]

docs = [
"beeware-docs-tools @ git+https://github.com/beeware/beeware-docs-tools",
# TODO: Restore main branch for final.
# "beeware-docs-tools @ git+https://github.com/beeware/beeware-docs-tools",
"beeware-docs-tools @ git+https://github.com/kattni/beeware-docs-tools@tooling/website-mkdocs-migration",
]

[tool.rumdl]
Expand All @@ -33,7 +35,6 @@ exclude = ["CODE_OF_CONDUCT.md"]
respect-gitignore = true

# Disable rules:
# MD013: Enforces line length
# MD014: Forces commands in codeblocks to show output
disable = ["MD014",]

Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ commands:
translate : update_machine_translations --soft-fail de es fr it pt zh_CN zh_TW
lint : markdown-checker --dir {[docs]docs_dir} --func check_broken_urls
lint : pyspelling
live : live_serve_en {posargs}
live : live_serve_en {posargs} --port=8041
all : build_md_translations {posargs} en de es fr it pt zh_CN zh_TW
en : build_md_translations {posargs} en
de : build_md_translations {posargs} de
Expand Down