From 63f993bcf6bbc2a773d4c53f8c0723384ccb5336 Mon Sep 17 00:00:00 2001 From: J08nY Date: Sun, 2 Feb 2025 14:22:05 +0100 Subject: Add docs about dataset layout. --- docs/api/dataset.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'docs/api') 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 -- cgit v1.3.1