Skip to content

Commit

Permalink
Fix erdantic docs and semantic tests.
Browse files Browse the repository at this point in the history
  • Loading branch information
mansenfranzen committed Mar 21, 2024
1 parent 204f246 commit f21298a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 6 additions & 4 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
name: Semantic Tests
on:
push:
branches-ignore:
- release-please--branches--main
branches:
- '*'
- '!release-please*'
pull_request:
branches-ignore:
- release-please--branches--main
branches:
- '*'
- '!release-please*'
workflow_dispatch:

jobs:
Expand Down
2 changes: 2 additions & 0 deletions docs/source/users/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ Contains all modifications for pydantic `BaseModel`.
:confpy: autodoc_pydantic_model_erdantic_figure
:directive_option: model-erdantic-figure
:values: True, False
:version: 1.9.0

Show the entity relationship diagram of the schemas using erdantic. To
use this option, you need first to install
Expand All @@ -205,6 +206,7 @@ Contains all modifications for pydantic `BaseModel`.
:directive_option: model-erdantic-figure-collapsed
:enable: model-erdantic-figure
:values: True, False
:version: 1.9.0

Show the entity relationship diagram collapsed or not.
:ref:`model-erdantic-figure <autodoc_pydantic_model_erdantic_figure>` must be True for this to have any effect.
Expand Down

0 comments on commit f21298a

Please sign in to comment.