cleaned-up repo structure

O-X-L · Sep 23, 2023 · 7a635b5 · 7a635b5
1 parent 61352f3
commit 7a635b5
Show file tree

Hide file tree

Showing 45 changed files with 99 additions and 0 deletions.
diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml
@@ -0,0 +1,21 @@
+---
+
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: 'ubuntu-22.04'
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: 'docs/source/conf.py'
+
+formats:
+  - 'pdf'
+  - 'epub'
+
+python:
+  install:
+    - requirements: 'docs/requirements.txt'
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx
+sphinx-rtd-theme
diff --git a/docs/source/_inc/head.rst b/docs/source/_inc/head.rst
@@ -0,0 +1,2 @@
+.. tip::
+    If you find some discrepancy or missing information - `open a GitHub issue <https://github.com/superstes/ShieldWall/issues/new>`_
diff --git a/docs/source/_inc/in_progress.rst b/docs/source/_inc/in_progress.rst
@@ -0,0 +1,2 @@
+.. warning::
+    Writing of this documentation is still in progress! Read it with a grain of salt!
diff --git a/docs/source/_static/css/main.css b/docs/source/_static/css/main.css
@@ -0,0 +1,17 @@
+.wiki-img {
+    width: 70%;
+    margin: 5px 0px;
+    border-radius: 5px;
+    border-style: solid;
+    border-color: #343a40;
+    border-width: 3px;
+}
+
+.wiki-img-sm {
+    width: 40%;
+    margin: 5px 0px;
+    border-radius: 5px;
+    border-style: solid;
+    border-color: #343a40;
+    border-width: 3px;
+}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,19 @@
+from datetime import datetime
+
+# pylint: disable=W0622
+
+project = 'Calamary'
+copyright = f'{datetime.now().year}, Superstes'
+author = 'Superstes'
+extensions = ['sphinx_rtd_theme']
+templates_path = ['_templates']
+exclude_patterns = []
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {}
+html_static_path = ['_static']
+html_css_files = ['css/main.css']
+master_doc = 'index'
+display_version = True
+sticky_navigation = True
+# html_logo = '_static/img/logo.svg'
+# html_favicon = 'img/favicon.ico'
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,14 @@
+.. include:: _inc/head.rst
+
+######################
+Camalary Documentation
+######################
+
+.. toctree::
+    :glob:
+    :maxdepth: 1
+
+    info/*
+
+
+.. include:: _inc/in_progress.rst
diff --git a/docs/source/info/intro.rst b/docs/source/info/intro.rst
@@ -0,0 +1,14 @@
+.. include:: _inc/head.rst
+
+#####
+Intro
+#####
+
+.. toctree::
+    :glob:
+    :maxdepth: 1
+
+    info/*
+
+
+.. include:: _inc/in_progress.rst
diff --git a/cnf/acl.go → lib/cnf/acl.go b/cnf/acl.go → lib/cnf/acl.go
diff --git a/cnf/config.go → lib/cnf/config.go b/cnf/config.go → lib/cnf/config.go
diff --git a/cnf/config.yml → lib/cnf/config.yml b/cnf/config.yml → lib/cnf/config.yml
diff --git a/cnf/filter.go → lib/cnf/filter.go b/cnf/filter.go → lib/cnf/filter.go
diff --git a/cnf/filter_test.go → lib/cnf/filter_test.go b/cnf/filter_test.go → lib/cnf/filter_test.go
diff --git a/cnf/load.go → lib/cnf/load.go b/cnf/load.go → lib/cnf/load.go
diff --git a/cnf/tmp.go → lib/cnf/tmp.go b/cnf/tmp.go → lib/cnf/tmp.go
diff --git a/cnf/vars.go → lib/cnf/vars.go b/cnf/vars.go → lib/cnf/vars.go
diff --git a/go.mod → lib/go.mod b/go.mod → lib/go.mod
diff --git a/go.sum → lib/go.sum b/go.sum → lib/go.sum
diff --git a/log/main.go → lib/log/main.go b/log/main.go → lib/log/main.go
diff --git a/main/main.go → lib/main/main.go b/main/main.go → lib/main/main.go
diff --git a/main/service.go → lib/main/service.go b/main/service.go → lib/main/service.go
diff --git a/proc/filter/main.go → lib/proc/filter/main.go b/proc/filter/main.go → lib/proc/filter/main.go
diff --git a/proc/filter/matches.go → lib/proc/filter/matches.go b/proc/filter/matches.go → lib/proc/filter/matches.go
diff --git a/proc/fwd/main.go → lib/proc/fwd/main.go b/proc/fwd/main.go → lib/proc/fwd/main.go
diff --git a/proc/meta/enum.go → lib/proc/meta/enum.go b/proc/meta/enum.go → lib/proc/meta/enum.go
diff --git a/proc/parse/helpers.go → lib/proc/parse/helpers.go b/proc/parse/helpers.go → lib/proc/parse/helpers.go
diff --git a/proc/parse/main.go → lib/proc/parse/main.go b/proc/parse/main.go → lib/proc/parse/main.go
diff --git a/proc/parse/pkg.go → lib/proc/parse/pkg.go b/proc/parse/pkg.go → lib/proc/parse/pkg.go
diff --git a/proc/parse/tcp.go → lib/proc/parse/tcp.go b/proc/parse/tcp.go → lib/proc/parse/tcp.go
diff --git a/proc/parse/tls/LICENSE → lib/proc/parse/tls/LICENSE b/proc/parse/tls/LICENSE → lib/proc/parse/tls/LICENSE
diff --git a/proc/parse/tls/extension.go → lib/proc/parse/tls/extension.go b/proc/parse/tls/extension.go → lib/proc/parse/tls/extension.go
diff --git a/proc/parse/tls/msg.go → lib/proc/parse/tls/msg.go b/proc/parse/tls/msg.go → lib/proc/parse/tls/msg.go
diff --git a/proc/parse/tls/record.go → lib/proc/parse/tls/record.go b/proc/parse/tls/record.go → lib/proc/parse/tls/record.go
diff --git a/proc/parse/tls/rfc5246_tls12.txt → lib/proc/parse/tls/rfc5246_tls12.txt b/proc/parse/tls/rfc5246_tls12.txt → lib/proc/parse/tls/rfc5246_tls12.txt
diff --git a/proc/parse/tls/source.txt → lib/proc/parse/tls/source.txt b/proc/parse/tls/source.txt → lib/proc/parse/tls/source.txt
diff --git a/proc/parse/udp.go → lib/proc/parse/udp.go b/proc/parse/udp.go → lib/proc/parse/udp.go
diff --git a/rcv/main.go → lib/rcv/main.go b/rcv/main.go → lib/rcv/main.go
diff --git a/rcv/start.go → lib/rcv/start.go b/rcv/start.go → lib/rcv/start.go
diff --git a/rcv/tcp.go → lib/rcv/tcp.go b/rcv/tcp.go → lib/rcv/tcp.go
diff --git a/rcv/udp.go → lib/rcv/udp.go b/rcv/udp.go → lib/rcv/udp.go
diff --git a/u/address.go → lib/u/address.go b/u/address.go → lib/u/address.go
diff --git a/u/bufferpool.go → lib/u/bufferpool.go b/u/bufferpool.go → lib/u/bufferpool.go
diff --git a/u/helpers.go → lib/u/helpers.go b/u/helpers.go → lib/u/helpers.go
diff --git a/u/transport.go → lib/u/transport.go b/u/transport.go → lib/u/transport.go
diff --git a/scripts/build_docs.sh b/scripts/build_docs.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+cd "$(dirname "$0")/../docs"
+
+rm -rf build
+mkdir build
+
+sphinx-build -b html source/ build/