Skip to content

Commit 2db0bc5

Browse files
rlabbeptcrlabbeptc
committed
Added API Documentation
API Documentation created with pdoc and added to host on Github Pages for repository.
1 parent c9e52e0 commit 2db0bc5

34 files changed

+19421
-10
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ _new*
1414
_test*
1515
_build*
1616
_dev*
17-
/docs
17+
# /docs
1818
mkdocs.yml
1919

2020
# Byte-compiled / optimized / DLL files

‎README.md

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

55
This is a package to help create Python applications to conduct operations with the Kepware Configuration API. This package is designed to work with all versions of Kepware that support the Configuration API including Thingworx Kepware Server (TKS), Thingworx Kepware Edge (TKE) and KEPServerEX (KEP).
66

7+
**API reference documentation is available on [Github Pages](https://ptcinc.github.io/Kepware-ConfigAPI-SDK-Python)**
8+
79
## Prerequisites
810

911
Package supported and tested on Python 3.9 or later. Older versions support earlier Python 3 environments but have less functionality. All HTTP communication is handled by the [urllib](https://docs.python.org/3/library/urllib.html#module-urllib) Python standard library.

‎docs/.nojekyll

Whitespace-only changes.

‎docs/index.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="refresh" content="0; url=./kepconfig.html"/>
6+
</head>
7+
</html>

‎docs/kepconfig.html

Lines changed: 512 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/kepconfig/admin.html

Lines changed: 258 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/kepconfig/admin/lls.html

Lines changed: 764 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/kepconfig/admin/ua_server.html

Lines changed: 688 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/kepconfig/admin/user_groups.html

Lines changed: 827 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/kepconfig/admin/users.html

Lines changed: 827 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)