From 9db545dbb2b644a01b8e49b4b2506ea03ec36b00 Mon Sep 17 00:00:00 2001
From: Adam Janovsky
Date: Fri, 20 May 2022 17:20:48 +0200
Subject: Docs: add some examples

---
 docs/api/dataset.md | 18 ++++++++++++++++++
 docs/api/sample.md  | 18 ++++++++++++++++++
 docs/index.md       | 19 ++++++++++++++++++-
 docs/quickstart.md  | 10 +++++++++-
 4 files changed, 63 insertions(+), 2 deletions(-)
 create mode 100644 docs/api/dataset.md
 create mode 100644 docs/api/sample.md

(limited to 'docs')

diff --git a/docs/api/dataset.md b/docs/api/dataset.md
new file mode 100644
index 00000000..ed92b31e
--- /dev/null
+++ b/docs/api/dataset.md
@@ -0,0 +1,18 @@
+# Dataset package
+
+```{eval-rst}
+.. automodule:: sec_certs.dataset
+    :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).
+```
+
+## CCDataset
+
+```{eval-rst}
+.. currentmodule:: sec_certs.dataset
+.. autoclass:: CCDataset
+    :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..29266f90
--- /dev/null
+++ b/docs/api/sample.md
@@ -0,0 +1,18 @@
+# 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:
+```
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index 3f44633b..8949debe 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -4,6 +4,13 @@ Welcome to the technical documentation of *sec-certs* tool for the data analysis
 
 There are three main parts of this documentation. *User's guide* describes high-level use of our tool. Driven by this knowledge, you can progress to *Notebook examples* that showcase most of the API that we use in the form of Jupyter notebooks. The documentation currently does not have all modules documented with `autodoc`, so for the API reference, you must directly inspect the [sec_certs](https://github.com/crocs-muni/sec-certs/tree/main/sec_certs) module. If you want, you can run the notebooks as they are stored in the [project repository](https://github.com/crocs-muni/sec-certs/tree/main/notebooks). If you are interested in contributing to our project or in other aspects of our development, you can consult the relevant *GitHub artifacts*
 
+```{button-ref} quickstart
+:align: center
+:color: primary
+:ref-type: myst
+Show me Quickstart!
+```
+
 ```{admonition} Launch notebooks in MyBinder
 Each of the notebooks can be launched interactively in MyBinder by clicking on 🚀 icon (top-right corner).
 ```
@@ -11,6 +18,7 @@ Each of the notebooks can be launched interactively in MyBinder by clicking on 
 ```{toctree}
 :hidden:
 :caption: Navigation
+:maxdepth: 1
 Seccerts homepage <https://seccerts.org/>
 Seccerts docs <https://seccerts.org/docs>
 GitHub repo <https://github.com/crocs-muni/sec-certs>
@@ -18,7 +26,9 @@ Seccerts PyPi <https://pypi.org/project/sec-certs/>
 ```
 
 ```{toctree}
+:hidden: True
 :caption: User's guide
+:maxdepth: 1
 installation.md
 quickstart.md
 tutorial.md
@@ -26,6 +36,8 @@ tutorial.md
 
 ```{toctree}
 :caption: Notebook examples
+:hidden: True
+:maxdepth: 1
 notebooks/examples/common_criteria.ipynb
 notebooks/examples/fips.ipynb
 notebooks/examples/model.ipynb
@@ -33,11 +45,16 @@ notebooks/examples/model.ipynb
 
 ```{toctree}
 :caption: API
+:hidden: True
+:maxdepth: 1
+api/sample.md
+api/dataset.md
 api/model.md
 ```
 
 ```{toctree}
-:maxdepth: 2
+:maxdepth: 1
+:hidden: True
 :caption: GitHub artifacts
 readme.md
 contributing.md
diff --git a/docs/quickstart.md b/docs/quickstart.md
index 14121212..721e1341 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -6,6 +6,8 @@
 1. Install the latest version with `pip install -U sec-certs` (see [installation](installation.md)).
 2. Use
 ```python
+from sec-certs.dataset import CCDataset
+
 dset = CCDataset.from_web_latest()
 ```
 to obtain to obtain freshly processed dataset from [seccerts.org](https://seccerts.org).
@@ -17,6 +19,8 @@ to obtain to obtain freshly processed dataset from [seccerts.org](https://seccer
 1. Install the latest version with `pip install -U sec-certs` (see [installation](installation.md)).
 2. Use
 ```python
+from sec-certs.dataset import FIPSDataset
+
 dset = FIPSDataset.from_web_latest()
 ```
 to obtain to obtain freshly processed dataset from [seccerts.org](https://seccerts.org).
@@ -45,4 +49,8 @@ $ fips-certs new-run
 :::
 ::::
 
-This script takes a long time to run (few hours) and will create `./cc_dset` or `./fips_dset` directory. To see all options, call the entrypoint with `--help`.
\ No newline at end of file
+This script takes a long time to run (few hours) and will create `./cc_dset` or `./fips_dset` directory. To see all options, call the entrypoint with `--help`.
+
+:::{hint}
+If you installed the docker image, use `docker run -it sec-certs bash` to run the container interactively.
+:::
-- 
cgit v1.3.1