Skip to content

Commit 1eca9f1

Browse files
committed
docs: add reference documentation for the settings
1 parent 46390ee commit 1eca9f1

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

docs/index.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,15 @@ have an existing workspace that you want to modify locally.
2626
[getting-started](https://github.com/Midnighter/structurizr-python/blob/devel/examples/getting_started.py)
2727
script will be suitable.
2828

29-
The `#!python main()` function in each example script creates a more or less involved
30-
workspace for you. When you have created a workspace, it is time to upload
31-
it so that you can create diagrams for it. You will need to create a
32-
[`StructurizrClient`][structurizr.api.structurizr_client.StructurizrClient] instance and its settings. The settings can be provided
33-
as arguments, be read from environment variables, or be provided in a `.env`
34-
file.
29+
The `#!python main()` function in each example script creates a more or less
30+
involved workspace for you. When you have created a workspace, it is time
31+
to upload it so that you can create diagrams for it. You will need to
32+
create a
33+
[`StructurizrClient`][structurizr.api.structurizr_client.StructurizrClient]
34+
instance and its
35+
[settings][structurizr.api.structurizr_client_settings.StructurizrClientSettings].
36+
The settings can be provided as arguments, be read from environment
37+
variables, or be provided in a `.env` file.
3538

3639
```python
3740
from structurizr import StructurizrClient, StructurizrClientSettings
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
::: structurizr.StructurizrClientSettings
2+
selection:
3+
filters:
4+
- '!Config'

0 commit comments

Comments
 (0)