sphinx quickstart

7 files changed, 164 insertions, 3 deletions

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 00000000..1867bfc1
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,12 @@
+name: "Build docs"
+on:
+  push:
+  workflow_dispatch:
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ammaraskar/sphinx-action@master
+        with:
+          docs-folder: "docs/"
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 00000000..d4bb2cbb
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 00000000..3617f9fc
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+from typing import List
+
+# -- Project information -----------------------------------------------------
+
+project = "sec-certs"
+copyright = "2022, Adam Janovsky, Petr Svenda, Jan Jancar, Jiri Michalik, Stanislav Bobon"
+author = "Adam Janovsky, Petr Svenda, Jan Jancar, Jiri Michalik, Stanislav Bobon"
+
+# The full version, including alpha/beta/rc tags
+release = "0.0.4"
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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] = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..9e16d741
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+.. 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/make.bat b/docs/make.bat
new file mode 100644
index 00000000..32bb2452
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF

+

+pushd %~dp0

+

+REM Command file for Sphinx documentation

+

+if "%SPHINXBUILD%" == "" (

+	set SPHINXBUILD=sphinx-build

+)

+set SOURCEDIR=.

+set BUILDDIR=_build

+

+%SPHINXBUILD% >NUL 2>NUL

+if errorlevel 9009 (

+	echo.

+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx

+	echo.installed, then set the SPHINXBUILD environment variable to point

+	echo.to the full path of the 'sphinx-build' executable. Alternatively you

+	echo.may add the Sphinx directory to PATH.

+	echo.

+	echo.If you don't have Sphinx installed, grab it from

+	echo.https://www.sphinx-doc.org/

+	exit /b 1

+)

+

+if "%1" == "" goto help

+

+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

+goto end

+

+:help

+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

+

+:end

+popd

diff --git a/requirements/dev_requirements.in b/requirements/dev_requirements.in
index 54bba20d..78f2c088 100644
--- a/requirements/dev_requirements.in
+++ b/requirements/dev_requirements.in
@@ -10,4 +10,5 @@ black
 isort
 flake8
 pre-commit
-pip-tools
\ No newline at end of file
+pip-tools
+sphinx
\ No newline at end of file
diff --git a/requirements/dev_requirements.txt b/requirements/dev_requirements.txt
index d11d2459..2132f9c8 100644
--- a/requirements/dev_requirements.txt
+++ b/requirements/dev_requirements.txt
@@ -1,4 +1,6 @@
+alabaster==0.7.12         # via sphinx
 attrs==21.4.0             # via pytest
+babel==2.10.1             # via sphinx
 black==22.3.0             # via -r dev_requirements.in
 certifi==2021.10.8        # via requests
 cfgv==3.3.1               # via pre-commit
@@ -6,19 +8,24 @@ charset-normalizer==2.0.12  # via requests
 click==8.1.2              # via black, pip-tools
 coverage[toml]==6.3.2     # via pytest-cov
 distlib==0.3.4            # via virtualenv
+docutils==0.17.1          # via sphinx
 filelock==3.6.0           # via virtualenv
 flake8==4.0.1             # via -r dev_requirements.in
 gprof2dot==2021.2.21      # via pytest-profiling
 identify==2.4.12          # via pre-commit
 idna==3.3                 # via requests
+imagesize==1.3.0          # via sphinx
+importlib-metadata==4.11.3  # via sphinx
 iniconfig==1.1.1          # via pytest
 isort==5.10.1             # via -r dev_requirements.in
+jinja2==3.1.1             # via sphinx
+markupsafe==2.1.1         # via jinja2
 mccabe==0.6.1             # via flake8
 memory-profiler==0.60.0   # via pytest-monitor
 mypy==0.942               # via -r dev_requirements.in
 mypy-extensions==0.4.3    # via black, mypy
 nodeenv==1.6.0            # via pre-commit
-packaging==21.3           # via pytest
+packaging==21.3           # via pytest, sphinx
 pathspec==0.9.0           # via black
 pep517==0.12.0            # via pip-tools
 pip-tools==6.5.1          # via -r dev_requirements.in
@@ -29,14 +36,24 @@ psutil==5.9.0             # via memory-profiler, pytest-monitor
 py==1.11.0                # via pytest
 pycodestyle==2.8.0        # via flake8
 pyflakes==2.4.0           # via flake8
+pygments==2.12.0          # via sphinx
 pyparsing==3.0.7          # via packaging
 pytest==7.1.1             # via -r dev_requirements.in, pytest-cov, pytest-monitor, pytest-profiling
 pytest-cov==3.0.0         # via -r dev_requirements.in
 pytest-monitor==1.6.3     # via -r dev_requirements.in
 pytest-profiling==1.7.0   # via -r dev_requirements.in
+pytz==2022.1              # via babel
 pyyaml==6.0               # via pre-commit
-requests==2.27.1          # via pytest-monitor
+requests==2.27.1          # via pytest-monitor, sphinx
 six==1.16.0               # via pytest-profiling, virtualenv
+snowballstemmer==2.2.0    # via sphinx
+sphinx==4.5.0             # via -r dev_requirements.in
+sphinxcontrib-applehelp==1.0.2  # via sphinx
+sphinxcontrib-devhelp==1.0.2  # via sphinx
+sphinxcontrib-htmlhelp==2.0.0  # via sphinx
+sphinxcontrib-jsmath==1.0.1  # via sphinx
+sphinxcontrib-qthelp==1.0.3  # via sphinx
+sphinxcontrib-serializinghtml==1.1.5  # via sphinx
 toml==0.10.2              # via pre-commit
 tomli==2.0.1              # via black, coverage, mypy, pep517, pytest
 types-python-dateutil==2.8.10  # via -r dev_requirements.in
@@ -47,6 +64,7 @@ typing-extensions==4.1.1  # via black, mypy
 urllib3==1.26.9           # via requests
 virtualenv==20.14.0       # via pre-commit
 wheel==0.37.1             # via pip-tools, pytest-monitor
+zipp==3.8.0               # via importlib-metadata
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip