Thanks to visit codestin.com
Credit goes to github.com

Skip to content

πŸ”¨ Verify mkdocs.yml languages in CI, update docs.py #11009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 4 commits into from
Jan 22, 2024
Merged

πŸ”¨ Verify mkdocs.yml languages in CI, update docs.py #11009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1fc79dd
πŸ”¨ Update docs.py script to verify mkdocs.yml from language_names.yml
tiangolo Jan 22, 2024
9d3d723
πŸ‘· Add new verify-docs to CI
tiangolo Jan 22, 2024
bdc1599
πŸ”§ Update CI step name
tiangolo Jan 22, 2024
0933d4e
πŸ”§ Update mkdocs.yml
tiangolo Jan 22, 2024
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
4 changes: 2 additions & 2 deletions .github/workflows/build-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ jobs:
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
- name: Verify README
run: python ./scripts/docs.py verify-readme
- name: Verify Docs
run: python ./scripts/docs.py verify-docs
- name: Export Language Codes
id: show-langs
run: |
Expand Down
6 changes: 4 additions & 2 deletions docs/en/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ markdown_extensions:
format: !!python/name:pymdownx.superfences.fence_code_format ''
pymdownx.tabbed:
alternate_style: true
pymdownx.tilde:
pymdownx.tilde: null
attr_list: null
md_in_html: null
extra:
Expand All @@ -267,6 +267,8 @@ extra:
alternate:
- link: /
name: en - English
- link: /bn/
name: bn - বাংলা
- link: /de/
name: de - Deutsch
- link: /es/
Expand Down Expand Up @@ -304,7 +306,7 @@ extra:
- link: /zh/
name: zh - 汉语
- link: /zh-hant/
name: zh - 繁體中文
name: zh-hant - 繁體中文
- link: /em/
name: πŸ˜‰
extra_css:
Expand Down
2 changes: 1 addition & 1 deletion scripts/build-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ set -e
set -x

# Check README.md is up to date
python ./scripts/docs.py verify-readme
python ./scripts/docs.py verify-docs
python ./scripts/docs.py build-all
32 changes: 31 additions & 1 deletion scripts/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ def live(
mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")


def update_config() -> None:
def get_updated_config_content() -> Dict[str, Any]:
config = get_en_config()
languages = [{"en": "/"}]
new_alternate: List[Dict[str, str]] = []
Expand Down Expand Up @@ -294,12 +294,42 @@ def update_config() -> None:
new_alternate.append({"link": url, "name": use_name})
new_alternate.append({"link": "/em/", "name": "πŸ˜‰"})
config["extra"]["alternate"] = new_alternate
return config


def update_config() -> None:
config = get_updated_config_content()
en_config_path.write_text(
yaml.dump(config, sort_keys=False, width=200, allow_unicode=True),
encoding="utf-8",
)


@app.command()
def verify_config() -> None:
"""
Verify main mkdocs.yml content to make sure it uses the latest language names.
"""
typer.echo("Verifying mkdocs.yml")
config = get_en_config()
updated_config = get_updated_config_content()
if config != updated_config:
typer.secho(
"docs/en/mkdocs.yml outdated from docs/language_names.yml, "
"update language_names.yml and run "
"python ./scripts/docs.py update-languages",
color=typer.colors.RED,
)
raise typer.Abort()
typer.echo("Valid mkdocs.yml βœ…")


@app.command()
def verify_docs():
verify_readme()
verify_config()


@app.command()
def langs_json():
langs = []
Expand Down