aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authoradamjanovsky2023-02-03 12:42:26 +0100
committerGitHub2023-02-03 12:42:26 +0100
commit3ed9d4dd94c2e4c4de0d874b65da9c33dec90ec1 (patch)
tree7256f205481ae7aeb2e27a11f776209bd12b23ca
parent45807250d977c58b1465bd79ae676c49b87f075b (diff)
parente9f777bc95a89897bd86170e17eb2a99e7436f53 (diff)
downloadsec-certs-3ed9d4dd94c2e4c4de0d874b65da9c33dec90ec1.tar.gz
sec-certs-3ed9d4dd94c2e4c4de0d874b65da9c33dec90ec1.tar.zst
sec-certs-3ed9d4dd94c2e4c4de0d874b65da9c33dec90ec1.zip
Merge pull request #309 from crocs-muni/deanonymize-docs
Deanonymize docs and ack IGA
-rw-r--r--README.md4
-rw-r--r--docs/conf.py4
-rw-r--r--docs/index.md7
3 files changed, 7 insertions, 8 deletions
diff --git a/README.md b/README.md
index e9943c13..ecb0f219 100644
--- a/README.md
+++ b/README.md
@@ -57,3 +57,7 @@ df_2015_and_newer = df.loc[df.year_from > 2014]
# Plot distribution of years of certification
df.year_from.value_counts().sort_index().plot.line()
```
+
+## Authors
+
+This work is being done at [CRoCS MUNI](https://crocs.fi.muni.cz/) by Adam Janovsky, Jan Jancar, Petr Svenda, Jiri Michalik, Lukasz Chmielewski and other contributors. This work was supported by the Internal grant agency of Masaryk University, CZ.02.2.69/0.0/0.0/19_073/0016943. \ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index 709afab6..562491f9 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -18,7 +18,7 @@ from importlib.metadata import version as get_version
# -- Project information -----------------------------------------------------
project = "sec-certs"
-copyright = "2020-2022"
+copyright = "CRoCS MUNI | 2020-2023"
# Note thas this inference won't work from Docker: https://github.com/pypa/setuptools_scm/#usage-from-docker
release = ".".join(get_version("sec-certs").split(".")[:3])
@@ -63,7 +63,7 @@ html_logo = "_static/logo.png"
html_favicon = "_static/logo_badge.png"
html_theme_options = {
- "repository_url": "https://anonymous.4open.science/r/sec-certs-7A92",
+ "repository_url": "https://github.com/crocs-muni/sec-certs",
"repository_branch": "main",
"launch_buttons": {"binderhub_url": "https://mybinder.org"},
"use_fullscreen_button": False,
diff --git a/docs/index.md b/docs/index.md
index 0b0ba966..1baac8e6 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,10 +1,5 @@
# Sec-certs documentation
-```{warning}
-This documentation was anonymized but may still contain occasional links back to the non-anonymous GitHub repository.
-```
-
-
Welcome to the technical documentation of *sec-certs* tool for the data analysis of products certified with Common Criteria or FIPS 140 frameworks. If you're looking for general description of the tool, its use cases and capabilites, we refer you to [sec-certs homepage](https://seccerts.org/). If you are looking for more advanced knowledge, e.g. how to mine your own data, how to extend the tool, and so forth, this is the right place.
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 some of the API that we use in the form of Jupyter notebooks. The documentation also contains some of the modules documented with `autodoc`, see *API reference*. Still, some dark corners of our codebase are not documented. To inspect the code directly, see the [sec_certs](https://github.com/crocs-muni/sec-certs/tree/main/src/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*
@@ -26,7 +21,7 @@ Each of the notebooks can be launched interactively in MyBinder by clicking on ð
:maxdepth: 1
Seccerts homepage <https://seccerts.org/>
Seccerts docs <https://seccerts.org/docs>
-GitHub repo <https://anonymous.4open.science/r/sec-certs-7A92/>
+GitHub repo <https://github.com/crocs-muni/sec-certs>
Seccerts PyPi <https://pypi.org/project/sec-certs/>
```