link external docs sources, introduce myst

12 files changed, 81 insertions, 37 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d539f656..afefc20b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-## Contributing
+# Contributing
 
 You contribution is warmly welcomed. You can help by:
 
@@ -20,9 +20,9 @@ Our [Dockerfile](https://github.com/crocs-muni/sec-certs/blob/main/docker/Docker
 ### Requirements
 
 Requirements are maintained with [pip-tools](https://github.com/jazzband/pip-tools). The main ideas are:
-- List actual dependencies in `.in` files inside [requirements](requirements) folder without pinning them.
-- Those dependencies are loaded into [setup.py](setup.py) file.
-- Additionally, [compile.sh](requirements/compile.sh) script is used to compile pinned versions of requirements that reside in `.txt` files in the same folder.
+- List actual dependencies in `.in` files inside [requirements](https://github.com/crocs-muni/sec-certs/blob/main/requirements) folder without pinning them.
+- Those dependencies are loaded into [setup.py](https://github.com/crocs-muni/sec-certs/blob/main/setup.py) file.
+- Additionally, [compile.sh](https://github.com/crocs-muni/sec-certs/blob/main/requirements/compile.sh) script is used to compile pinned versions of requirements that reside in `.txt` files in the same folder.
 - Tests, linting and Docker all run against this reproducible environment of pinned requirements.
 
 ## Branches and releases
@@ -35,12 +35,12 @@ Requirements are maintained with [pip-tools](https://github.com/jazzband/pip-too
 
 All commits shall pass the lint pipeline of the following tools:
 
-- Mypy (see [pyproject.toml](https://github.com/crocs-muni/sec-certs/blob/dev/pyproject.toml) for settings)
-- Black (see [pyproject.toml](https://github.com/crocs-muni/sec-certs/blob/dev/pyproject.toml) for settings)
-- isort (see [pyproject.toml](https://github.com/crocs-muni/sec-certs/blob/dev/pyproject.toml) for settings)
-- Flake8 (see [.flake8](https://github.com/crocs-muni/sec-certs/blob/dev/.flake8) for settings)
+- Mypy (see [pyproject.toml](https://github.com/crocs-muni/sec-certs/blob/main/pyproject.toml) for settings)
+- Black (see [pyproject.toml](https://github.com/crocs-muni/sec-certs/blob/main/pyproject.toml) for settings)
+- isort (see [pyproject.toml](https://github.com/crocs-muni/sec-certs/blob/main/pyproject.toml) for settings)
+- Flake8 (see [.flake8](https://github.com/crocs-muni/sec-certs/blob/main/.flake8) for settings)
 
-These tools can be installed via [dev_requirements.txt](https://github.com/crocs-muni/sec-certs/blob/dev/dev_requirements.txt) You can use [pre-commit](https://pre-commit.com/) tool register git hook that will evalute these checks prior to any commit and abort the commit for you. Note that the pre-commit is not meant to automatically fix the issues, just warn you.
+These tools can be installed via [dev_requirements.txt](https://github.com/crocs-muni/sec-certs/blob/main/dev_requirements.txt) You can use [pre-commit](https://pre-commit.com/) tool register git hook that will evalute these checks prior to any commit and abort the commit for you. Note that the pre-commit is not meant to automatically fix the issues, just warn you.
 
 It should thus suffice to:
 
diff --git a/LICENSE b/LICENSE
index 5359145a..55e4ec93 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Petr Svenda
+Copyright (c) 2019-2022 Petr Svenda, Adam Janovsky, Jan Jancar, Jiri Michalik, Stanislav Bobon
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index 29da0021..69a036d3 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# ![](docs/_static/logo.svg)
+# Sec-certs
+
+![](docs/_static/logo.svg)
 
 Tool for analysis of security certificates and their security targets (Common Criteria, NIST FIPS140-2...).
 
diff --git a/docs/code_of_conduct.md b/docs/code_of_conduct.md
new file mode 100644
index 00000000..74e5474b
--- /dev/null
+++ b/docs/code_of_conduct.md
@@ -0,0 +1,4 @@
+```{include} ../CODE_OF_CONDUCT.md
+:relative-docs: docs/
+:relative-images:
+```
diff --git a/docs/conf.py b/docs/conf.py
index 3617f9fc..23392e9c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -31,7 +31,7 @@ release = "0.0.4"
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions: List[str] = []
+extensions: List[str] = ["myst_parser"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -47,7 +47,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "sphinx_book_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
diff --git a/docs/contributing.md b/docs/contributing.md
new file mode 100644
index 00000000..fc1b2138
--- /dev/null
+++ b/docs/contributing.md
@@ -0,0 +1,4 @@
+```{include} ../CONTRIBUTING.md
+:relative-docs: docs/
+:relative-images:
+```
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 00000000..4554a3b2
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,10 @@
+# Sec-certs documentation
+
+```{toctree}
+:maxdepth: 2
+readme.md
+contributing.md
+code_of_conduct.md
+license.md
+```
+
diff --git a/docs/index.rst b/docs/index.rst
deleted file mode 100644
index 9e16d741..00000000
--- a/docs/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-.. sec-certs documentation master file, created by
-   sphinx-quickstart on Sun Apr 24 20:56:46 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to sec-certs's documentation!
-=====================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/license.md b/docs/license.md
new file mode 100644
index 00000000..4f6e8060
--- /dev/null
+++ b/docs/license.md
@@ -0,0 +1,6 @@
+# License
+
+```{include} ../LICENSE
+:relative-docs: docs/
+:relative-images:
+```
diff --git a/docs/readme.md b/docs/readme.md
new file mode 100644
index 00000000..2cb706b3
--- /dev/null
+++ b/docs/readme.md
@@ -0,0 +1,4 @@
+```{include} ../README.md
+:relative-docs: docs/
+:relative-images:
+```
diff --git a/requirements/dev_requirements.in b/requirements/dev_requirements.in
index 78f2c088..824a102f 100644
--- a/requirements/dev_requirements.in
+++ b/requirements/dev_requirements.in
@@ -11,4 +11,6 @@ isort
 flake8
 pre-commit
 pip-tools
-sphinx
\ No newline at end of file
+sphinx
+myst-parser
+sphinx-book-theme
\ No newline at end of file
diff --git a/requirements/dev_requirements.txt b/requirements/dev_requirements.txt
index 2b91f06b..97debe7f 100644
--- a/requirements/dev_requirements.txt
+++ b/requirements/dev_requirements.txt
@@ -4,6 +4,8 @@ attrs==21.4.0
     # via pytest
 babel==2.10.1
     # via sphinx
+beautifulsoup4==4.11.1
+    # via pydata-sphinx-theme
 black==22.3.0
     # via -r dev_requirements.in
 certifi==2021.10.8
@@ -21,7 +23,10 @@ coverage[toml]==6.3.2
 distlib==0.3.4
     # via virtualenv
 docutils==0.17.1
-    # via sphinx
+    # via
+    #   myst-parser
+    #   pydata-sphinx-theme
+    #   sphinx
 filelock==3.6.0
     # via virtualenv
 flake8==4.0.1
@@ -41,11 +46,21 @@ iniconfig==1.1.1
 isort==5.10.1
     # via -r dev_requirements.in
 jinja2==3.1.1
-    # via sphinx
+    # via
+    #   myst-parser
+    #   sphinx
+markdown-it-py==2.1.0
+    # via
+    #   mdit-py-plugins
+    #   myst-parser
 markupsafe==2.1.1
     # via jinja2
 mccabe==0.6.1
     # via flake8
+mdit-py-plugins==0.3.0
+    # via myst-parser
+mdurl==0.1.1
+    # via markdown-it-py
 memory-profiler==0.60.0
     # via pytest-monitor
 mypy==0.942
@@ -54,10 +69,13 @@ mypy-extensions==0.4.3
     # via
     #   black
     #   mypy
+myst-parser==0.17.2
+    # via -r dev_requirements.in
 nodeenv==1.6.0
     # via pre-commit
 packaging==21.3
     # via
+    #   pydata-sphinx-theme
     #   pytest
     #   sphinx
 pathspec==0.9.0
@@ -82,6 +100,8 @@ py==1.11.0
     # via pytest
 pycodestyle==2.8.0
     # via flake8
+pydata-sphinx-theme==0.8.1
+    # via sphinx-book-theme
 pyflakes==2.4.0
     # via flake8
 pygments==2.12.0
@@ -103,7 +123,10 @@ pytest-profiling==1.7.0
 pytz==2022.1
     # via babel
 pyyaml==6.0
-    # via pre-commit
+    # via
+    #   myst-parser
+    #   pre-commit
+    #   sphinx-book-theme
 requests==2.27.1
     # via
     #   pytest-monitor
@@ -114,7 +137,15 @@ six==1.16.0
     #   virtualenv
 snowballstemmer==2.2.0
     # via sphinx
+soupsieve==2.3.2.post1
+    # via beautifulsoup4
 sphinx==4.5.0
+    # via
+    #   -r dev_requirements.in
+    #   myst-parser
+    #   pydata-sphinx-theme
+    #   sphinx-book-theme
+sphinx-book-theme==0.3.2
     # via -r dev_requirements.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
@@ -149,6 +180,7 @@ typing-extensions==4.1.1
     # via
     #   black
     #   mypy
+    #   myst-parser
 urllib3==1.26.9
     # via requests
 virtualenv==20.14.0