aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/api/sample.md
diff options
context:
space:
mode:
authoradamjanovsky2022-05-27 08:00:09 +0200
committerGitHub2022-05-27 08:00:09 +0200
commit23832d00a541b2d42859bd3f1aeaca4c514bcb82 (patch)
tree4f322859b8321ba88a47abbdcccbb7c50179e72e /docs/api/sample.md
parent0c12f7fec7778279a9c6ab1fc3d1b6868e7dcd86 (diff)
parent1de0b977015e625db30a98f22cac4f098fbb404c (diff)
downloadsec-certs-23832d00a541b2d42859bd3f1aeaca4c514bcb82.tar.gz
sec-certs-23832d00a541b2d42859bd3f1aeaca4c514bcb82.tar.zst
sec-certs-23832d00a541b2d42859bd3f1aeaca4c514bcb82.zip
Merge pull request #196 from crocs-muni/issue/195-Docs
Docs
Diffstat (limited to 'docs/api/sample.md')
-rw-r--r--docs/api/sample.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/api/sample.md b/docs/api/sample.md
new file mode 100644
index 00000000..4ff17be1
--- /dev/null
+++ b/docs/api/sample.md
@@ -0,0 +1,26 @@
+# 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:
+```
+
+## FIPSCertificate
+
+```{eval-rst}
+.. currentmodule:: sec_certs.sample
+.. autoclass:: FIPSCertificate
+ :members:
+``` \ No newline at end of file