Merge pull request #196 from crocs-muni/issue/195-Docs

Docs

3 files changed, 96 insertions, 0 deletions

diff --git a/docs/api/dataset.md b/docs/api/dataset.md
new file mode 100644
index 00000000..168fa12a
--- /dev/null
+++ b/docs/api/dataset.md
@@ -0,0 +1,28 @@
+# Dataset package
+
+```{eval-rst}
+.. automodule:: sec_certs.dataset
+    :no-members:
+```
+
+This documentation doesn't provide full API reference for all members of `dataset` package. Instead, it concentrattes on the Dataset that are immediately exposed to the users. Namely, we focus on `CCDataset` and `FIPSDataset`.
+
+```{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:
+```
+
+## FIPSDataset
+
+```{eval-rst}
+.. currentmodule:: sec_certs.dataset
+.. autoclass:: FIPSDataset
+    :members:
+```
diff --git a/docs/api/model.md b/docs/api/model.md
new file mode 100644
index 00000000..406d24be
--- /dev/null
+++ b/docs/api/model.md
@@ -0,0 +1,42 @@
+# 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}
+.. currentmodule:: sec_certs.model
+.. autoclass:: CPEClassifier
+    :members:
+```
+
+## SARTranformer
+
+```{eval-rst}
+.. currentmodule:: sec_certs.model
+.. autoclass:: SARTransformer
+    :members:
+```
+
+## 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
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