Skip to content

Commit 128a721

Browse files
committed
docs: add reference documentation for the client
1 parent bbde267 commit 128a721

File tree

7 files changed

+16
-7
lines changed

7 files changed

+16
-7
lines changed

docs/.pages

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
nav:
2-
- Home: index.md
3-
- Reference: reference
2+
- Overview: index.md
3+
- reference
44
- ...

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ have an existing workspace that you want to modify locally.
2929
The `#!python main()` function in each example script creates a more or less involved
3030
workspace for you. When you have created a workspace, it is time to upload
3131
it so that you can create diagrams for it. You will need to create a
32-
`#!python StructurizrClient` instance and its settings. The settings can be provided
32+
[`StructurizrClient`][structurizr.api.structurizr_client.StructurizrClient] instance and its settings. The settings can be provided
3333
as arguments, be read from environment variables, or be provided in a `.env`
3434
file.
3535

docs/reference/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: Reference
1+
title: API Reference
22

33
nav:
44
- ...
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
::: structurizr.StructurizrClient
2+
selection:
3+
members:
4+
- get_workspace
5+
- put_workspace
6+
- lock_workspace
7+
- unlock_workspace

docs/reference/structurizr.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
mkdocs ~=1.1
22
mkdocs-material ~=6.1
33
mkdocs-awesome-pages-plugin ~=2.4
4-
mkdocstrings ~=0.13
4+
mkdocstrings ~=0.14

mkdocs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ plugins:
2828
handlers:
2929
python:
3030
rendering:
31-
show_source: false
31+
show_source: true
32+
show_root_heading: false
33+
show_root_toc_entry: true
34+
show_root_full_path: false
3235
watch:
3336
- src/structurizr
3437

0 commit comments

Comments
 (0)