diff options
| author | Adam Janovsky | 2022-05-22 13:43:36 +0200 |
|---|---|---|
| committer | Adam Janovsky | 2022-05-22 13:43:36 +0200 |
| commit | 5d1e1e8346489911eda02892e67823738dfb9e47 (patch) | |
| tree | 2f6201ff3775976f2feb84c078e4e3bff38dee83 /docs/api | |
| parent | 5fcb216c86dd9b1c3e9cc82822276233ed1024a8 (diff) | |
| download | sec-certs-5d1e1e8346489911eda02892e67823738dfb9e47.tar.gz sec-certs-5d1e1e8346489911eda02892e67823738dfb9e47.tar.zst sec-certs-5d1e1e8346489911eda02892e67823738dfb9e47.zip | |
add fipsdataset docs
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/dataset.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/api/dataset.md b/docs/api/dataset.md index ed92b31e..168fa12a 100644 --- a/docs/api/dataset.md +++ b/docs/api/dataset.md @@ -5,6 +5,8 @@ :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). ``` @@ -15,4 +17,12 @@ The examples related to this package can be found at [common criteria notebook]( .. currentmodule:: sec_certs.dataset .. autoclass:: CCDataset :members: -```
\ No newline at end of file +``` + +## FIPSDataset + +```{eval-rst} +.. currentmodule:: sec_certs.dataset +.. autoclass:: FIPSDataset + :members: +``` |