aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/api
diff options
context:
space:
mode:
authorJ08nY2025-02-02 14:22:05 +0100
committerJ08nY2025-02-02 14:22:05 +0100
commit63f993bcf6bbc2a773d4c53f8c0723384ccb5336 (patch)
tree980be8fe3fec4b49fd298d74a2cd290b783df698 /docs/api
parentb128c47291de8654b6b7ab0e225751847f286ea2 (diff)
downloadsec-certs-63f993bcf6bbc2a773d4c53f8c0723384ccb5336.tar.gz
sec-certs-63f993bcf6bbc2a773d4c53f8c0723384ccb5336.tar.zst
sec-certs-63f993bcf6bbc2a773d4c53f8c0723384ccb5336.zip
Add docs about dataset layout.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/dataset.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/api/dataset.md b/docs/api/dataset.md
index a3b8a836..fbb89baf 100644
--- a/docs/api/dataset.md
+++ b/docs/api/dataset.md
@@ -5,13 +5,15 @@
:no-members:
```
-This documentation doesn't provide full API reference for all members of `dataset` package. Instead, it concentrates on the Dataset that are immediately exposed to the users. Namely, we focus on `CCDataset`, `FIPSDataset` and their abstract base class `Dataset`.
+This documentation doesn't provide full API reference for all members of `dataset` package. Instead, it concentrates on the Dataset that are immediately exposed to the users.
+Namely, we focus on `CCDataset`, `FIPSDataset`, `ProtectionProfileDataset` and their abstract base class `Dataset`.
```{tip}
-The examples related to this package can be found in the [common criteria notebook](./../notebooks/examples/cc.ipynb) and the [fips notebook](./../notebooks/examples/fips.ipynb).
+The examples related to this package can be found in the [common criteria notebook](./../notebooks/examples/cc.ipynb),
+the [protection profile notebook](./../notebooks/examples/protection_profiles.ipynb), and the [fips notebook](./../notebooks/examples/fips.ipynb).
```
-## CCDataset
+## Base Dataset
```{eval-rst}
.. currentmodule:: sec_certs.dataset.dataset
@@ -19,6 +21,8 @@ The examples related to this package can be found in the [common criteria notebo
:members:
```
+## CCDataset
+
```{eval-rst}
.. currentmodule:: sec_certs.dataset
.. autoclass:: CCDataset