Skip to content

Commit

Permalink
chore: Synchronize public/insiders
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Oct 11, 2024
1 parent d998774 commit 6a9ca1d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion duties.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]:mkdocstrings/griffe", silent=True, nofail=True)
ctx.run(
Expand Down

0 comments on commit 6a9ca1d

Please sign in to comment.