Skip to content

Commit c646773

Browse files
committed
Add minor changes to docs
1 parent d250952 commit c646773

File tree

6 files changed

+4
-12
lines changed

6 files changed

+4
-12
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
**Python Camunda SDK** is an implementation of [Camunda](https://camunda.com/) SDK in Python built on top of [pyzeebe](https://github.com/camunda-community-hub/pyzeebe).
88

9-
It simplifies the definitions of outbound and inbound connectors and utilises [pydantic](https://pydantic.dev/) for data validation.
10-
119
## Features
1210

1311
* Inbound and Outbound connector classes

docs/api/connectors/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Classes to configure connectors.
44

55
!!! warning
66
These classes should not be used directly. Instead define a
7-
`ConnectorConfig` class in the scope of the connector with the fields set to
7+
`ConnectorConfig` class in the scope of the connector class with the fields set to
88
the desired values. They are then validated and converted to these
99
classes internally.
1010

docs/api/templates/generate_template.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,3 @@ Usage: generate_template [OPTIONS] CONNECTOR FILENAME
1616
Options:
1717
--help Show this message and exit.
1818
```
19-
20-
21-
::: python_camunda_sdk.templates.generate_template
22-

docs/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
![Pycam logo](img/pycam.svg){ width="100" }
2-
# About
2+
# Python Camunda SDK
33

44
**Python Camunda SDK** is an implementation of [Camunda](https://camunda.com/) SDK in Python built on top of [pyzeebe](https://github.com/camunda-community-hub/pyzeebe).
55

6-
It simplifies the definitions of outbound and inbound connectors and utilises [pydantic](https://pydantic.dev/) for data validation.
7-
86
[Get started](quick_start){ .md-button }
97

108
## Features

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ plugins:
6666
- python_camunda_sdk
6767

6868
nav:
69-
- About: index.md
69+
- Home: index.md
7070
- Quick start:
7171
- quick_start/index.md
7272
- Outbound connectors:

python_camunda_sdk/templates/template.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ def generate_template(cls: Connector) -> CamundaTemplate:
119119
Converts connector class into a Camunda template mapping class fields
120120
into template inputs.
121121
122-
Agrs:
122+
Parameters:
123123
cls: Connector class.
124124
125125
Example:

0 commit comments

Comments
 (0)