aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/api
diff options
context:
space:
mode:
authorAdam Janovsky2022-05-20 17:20:48 +0200
committerAdam Janovsky2022-05-20 17:20:48 +0200
commit9db545dbb2b644a01b8e49b4b2506ea03ec36b00 (patch)
treeb7a197b47a77ad46a7df1eef3af64c911c3641c4 /docs/api
parent4d7078d81f38d5ab4e31525ff8094be449e3b3b8 (diff)
downloadsec-certs-9db545dbb2b644a01b8e49b4b2506ea03ec36b00.tar.gz
sec-certs-9db545dbb2b644a01b8e49b4b2506ea03ec36b00.tar.zst
sec-certs-9db545dbb2b644a01b8e49b4b2506ea03ec36b00.zip
Docs: add some examples
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/dataset.md18
-rw-r--r--docs/api/sample.md18
2 files changed, 36 insertions, 0 deletions
diff --git a/docs/api/dataset.md b/docs/api/dataset.md
new file mode 100644
index 00000000..ed92b31e
--- /dev/null
+++ b/docs/api/dataset.md
@@ -0,0 +1,18 @@
+# Dataset package
+
+```{eval-rst}
+.. automodule:: sec_certs.dataset
+ :no-members:
+```
+
+```{tip}
+The examples related to this package can be found at [common criteria notebook](./../notebooks/examples/common_criteria.ipynb) and [fips notebook](./../notebooks/examples/fips.ipynb).
+```
+
+## CCDataset
+
+```{eval-rst}
+.. currentmodule:: sec_certs.dataset
+.. autoclass:: CCDataset
+ :members:
+``` \ No newline at end of file
diff --git a/docs/api/sample.md b/docs/api/sample.md
new file mode 100644
index 00000000..29266f90
--- /dev/null
+++ b/docs/api/sample.md
@@ -0,0 +1,18 @@
+# Sample package
+
+```{eval-rst}
+.. automodule:: sec_certs.sample
+ :no-members:
+```
+
+```{tip}
+The examples related to this package can be found at [common criteria notebook](./../notebooks/examples/common_criteria.ipynb) and [fips notebook](./../notebooks/examples/fips.ipynb).
+```
+
+## CommonCriteriaCert
+
+```{eval-rst}
+.. currentmodule:: sec_certs.sample
+.. autoclass:: CommonCriteriaCert
+ :members:
+``` \ No newline at end of file