aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/api
diff options
context:
space:
mode:
authorAdam Janovsky2022-05-20 15:25:28 +0200
committerAdam Janovsky2022-05-20 15:25:28 +0200
commit99768447af7031d4ceb982ba58f49fcf8d4c4591 (patch)
tree232c8453fff682f484c66b599d7ef7e9cd4d3b33 /docs/api
parentdab67350a43c67d16d808286eb709b4354692539 (diff)
downloadsec-certs-99768447af7031d4ceb982ba58f49fcf8d4c4591.tar.gz
sec-certs-99768447af7031d4ceb982ba58f49fcf8d4c4591.tar.zst
sec-certs-99768447af7031d4ceb982ba58f49fcf8d4c4591.zip
update docs
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/model.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/api/model.md b/docs/api/model.md
index 372815c7..406d24be 100644
--- a/docs/api/model.md
+++ b/docs/api/model.md
@@ -1,5 +1,14 @@
# Model package
+```{eval-rst}
+.. automodule:: sec_certs.model
+ :no-members:
+```
+
+```{tip}
+The examples related to this package can be found at [model notebook](./../notebooks/examples/model.ipynb).
+```
+
## CPEClassifier
```{eval-rst}
@@ -18,3 +27,16 @@
## DependencyFinder
+```{eval-rst}
+.. currentmodule:: sec_certs.model
+.. autoclass:: DependencyFinder
+ :members:
+```
+
+## DependencyVulnerabilityFinder
+
+```{eval-rst}
+.. currentmodule:: sec_certs.model
+.. autoclass:: DependencyVulnerabilityFinder
+ :members:
+``` \ No newline at end of file