From 6a9ca1d8653bdf834c48aa978e716db9b17765be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Fri, 11 Oct 2024 14:49:05 +0200 Subject: [PATCH] chore: Synchronize public/insiders --- README.md | 8 +++++++- duties.py | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1bd95383..9192c68f 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ pipx install griffe ## Usage +### Dump JSON-serialized API + **On the command line**, pass the names of packages to the `griffe dump` command: ```console @@ -52,7 +54,9 @@ $ griffe dump httpx fastapi See the [Serializing chapter](https://mkdocstrings.github.io/griffe/guide/users/serializing/) for more examples. -Or pass a relative path to the `griffe check` command: +### Check for API breaking changes + +Pass a relative path to the `griffe check` command: ```console $ griffe check mypackage --verbose @@ -89,6 +93,8 @@ griffe check package_name -b project-name==2.0 -a project-name==1.0 See the [Checking chapter](https://mkdocstrings.github.io/griffe/guide/users/checking/) for more examples. +### Load and navigate data with Python + **With Python**, loading a package: ```python diff --git a/duties.py b/duties.py index 87600705..4d6ef0d2 100644 --- a/duties.py +++ b/duties.py @@ -308,7 +308,7 @@ def docs_deploy(ctx: Context) -> None: with material_insiders() as insiders: if not insiders: ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!") - origin = ctx.run("git config --get remote.origin.url", silent=True) + origin = ctx.run("git config --get remote.origin.url", silent=True, allow_overrides=False) if "pawamoy-insiders/griffe" in origin: ctx.run("git remote add upstream git@github.com:mkdocstrings/griffe", silent=True, nofail=True) ctx.run(