Update docs

seanthegeek · Dec 29, 2023 · 3e0b79a · 3e0b79a
1 parent 0ff8529
commit 3e0b79a
Show file tree

Hide file tree

Showing 13 changed files with 68 additions and 44 deletions.
diff --git a/_modules/index.html b/_modules/index.html
@@ -1,11 +1,13 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="../">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Overview: module code &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/_modules/yaramail.html b/_modules/yaramail.html
@@ -1,11 +1,13 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="../">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>yaramail &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/_sources/tutorial.md.txt b/_sources/tutorial.md.txt
@@ -357,7 +357,7 @@ rule planet_express_vip_impersonation {
         description = "Impersonation of key employees of Planet Express"
     strings:
         /*
-        /(Hubert|Hugh|Prof\\.?(essor)?) ((Hubert|Hugh) )?Farnsworth/
+        /(Hubert|Hugh|Prof\.?(essor)?) ((Hubert|Hugh) )?Farnsworth/
 
         Hubert Farnsworth
         Hugh Farnsworth
@@ -371,7 +371,7 @@ rule planet_express_vip_impersonation {
         Prof. Hugh Farnsworth
         Prof Hugh Farnsworth
 
-        /Phil(ip)? (J\\.? )?Fry/
+        /Phil(ip)? (J\.? )?Fry/
 
         Philip Fry
         Philip J. Fry
@@ -381,11 +381,11 @@ rule planet_express_vip_impersonation {
         Phil J Fry
         */
         $external = "[EXT]" ascii wide nocase // External email warning
-        $vip_ceo = /(Hubert|Hugh|Prof\\.?(essor)?) ((Hubert|Hugh) )?Farnsworth/ ascii wide nocase
+        $vip_ceo = /(Hubert|Hugh|Prof\.?(essor)?) ((Hubert|Hugh) )?Farnsworth/ ascii wide nocase
         $vip_cfo = "Hermes Conrad" ascii wide nocase
         $vip_cto = "Turanga Leela" ascii wide nocase
         $vip_admin = "Amy Wong" ascii wide nocase
-        $vip_cdo = /Phil(ip)? (J\\.? )?Fry/ ascii wide nocase
+        $vip_cdo = /Phil(ip)? (J\.? )?Fry/ ascii wide nocase
         $except_slug = "Brain Slug Fundraiser" ascii wide
     condition:
         $external and any of ($vip_*) and not any of ($except_*)

diff --git a/api.html b/api.html
@@ -1,12 +1,14 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>API &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/cli.html b/cli.html
@@ -1,12 +1,14 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>CLI &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/collecting_samples.html b/collecting_samples.html
@@ -1,12 +1,14 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Collecting email samples &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/genindex.html b/genindex.html
@@ -1,11 +1,13 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Index &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/index.html b/index.html
@@ -1,12 +1,14 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Welcome to yaramail’s documentation &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/installation.html b/installation.html
@@ -1,12 +1,14 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Installation &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/py-modindex.html b/py-modindex.html
@@ -1,11 +1,13 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Python Module Index &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/regex.html b/regex.html
@@ -1,12 +1,14 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>regex quick reference &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->

diff --git a/search.html b/search.html
@@ -1,11 +1,13 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Search &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
 
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>

diff --git a/tutorial.html b/tutorial.html
@@ -1,12 +1,14 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Tutorial &mdash; yaramail 3.2.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
@@ -481,7 +483,7 @@ <h3>Checking for impersonation<a class="headerlink" href="#checking-for-imperson
 <span class="w">        </span><span class="n">description</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;Impersonation of key employees of Planet Express&quot;</span>
 <span class="w">    </span><span class="k">strings</span><span class="p">:</span>
 <span class="w">        </span><span class="cm">/*</span>
-<span class="cm">        /(Hubert|Hugh|Prof\\.?(essor)?) ((Hubert|Hugh) )?Farnsworth/</span>
+<span class="cm">        /(Hubert|Hugh|Prof\.?(essor)?) ((Hubert|Hugh) )?Farnsworth/</span>
 <span class="cm">        </span>
 <span class="cm">        Hubert Farnsworth</span>
 <span class="cm">        Hugh Farnsworth</span>
@@ -495,7 +497,7 @@ <h3>Checking for impersonation<a class="headerlink" href="#checking-for-imperson
 <span class="cm">        Prof. Hugh Farnsworth</span>
 <span class="cm">        Prof Hugh Farnsworth</span>
 <span class="cm">        </span>
-<span class="cm">        /Phil(ip)? (J\\.? )?Fry/</span>
+<span class="cm">        /Phil(ip)? (J\.? )?Fry/</span>
 <span class="cm">        </span>
 <span class="cm">        Philip Fry</span>
 <span class="cm">        Philip J. Fry</span>
@@ -505,11 +507,11 @@ <h3>Checking for impersonation<a class="headerlink" href="#checking-for-imperson
 <span class="cm">        Phil J Fry</span>
 <span class="cm">        */</span>
 <span class="w">        </span><span class="nv">$external</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;[EXT]&quot;</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span><span class="w"> </span><span class="nb">nocase</span><span class="w"> </span><span class="c1">// External email warning</span>
-<span class="w">        </span><span class="nv">$vip_ceo</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="sr">/(Hubert|Hugh|Prof\\.?(essor)?) ((Hubert|Hugh) )?Farnsworth/</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span><span class="w"> </span><span class="nb">nocase</span>
+<span class="w">        </span><span class="nv">$vip_ceo</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="sr">/(Hubert|Hugh|Prof\.?(essor)?) ((Hubert|Hugh) )?Farnsworth/</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span><span class="w"> </span><span class="nb">nocase</span>
 <span class="w">        </span><span class="nv">$vip_cfo</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;Hermes Conrad&quot;</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span><span class="w"> </span><span class="nb">nocase</span>
 <span class="w">        </span><span class="nv">$vip_cto</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;Turanga Leela&quot;</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span><span class="w"> </span><span class="nb">nocase</span>
 <span class="w">        </span><span class="nv">$vip_admin</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;Amy Wong&quot;</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span><span class="w"> </span><span class="nb">nocase</span>
-<span class="w">        </span><span class="nv">$vip_cdo</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="sr">/Phil(ip)? (J\\.? )?Fry/</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span><span class="w"> </span><span class="nb">nocase</span>
+<span class="w">        </span><span class="nv">$vip_cdo</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="sr">/Phil(ip)? (J\.? )?Fry/</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span><span class="w"> </span><span class="nb">nocase</span>
 <span class="w">        </span><span class="nv">$except_slug</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;Brain Slug Fundraiser&quot;</span><span class="w"> </span><span class="nb">ascii</span><span class="w"> </span><span class="nb">wide</span>
 <span class="w">    </span><span class="k">condition</span><span class="p">:</span>
 <span class="w">        </span><span class="nv">$external</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="ow">any</span><span class="w"> </span><span class="nb">of</span><span class="w"> </span><span class="p">(</span><span class="nv">$vip_</span><span class="p">*)</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="ow">any</span><span class="w"> </span><span class="nb">of</span><span class="w"> </span><span class="p">(</span><span class="nv">$except_</span><span class="p">*)</span>