Adding Sphinx documentation for Read the docs (#6)

* Adding Sphinx documentation for Read the docs

* Updating requirements.txt

* Fixing some more line-length warnings

* Removing intake (breaking build on pip install)

Fixing some errors in iocextract

* Updating JupyterAndSecurity doc.

Adding function to execute simple kql string query.

* Warning fixes for flake8 (mostly line length)

* A couple more pylint warning fixes/suppressions

* Adding Linux Auditd collection document.

* Removing  license parameter from setuptools.setup

This seems to cause the license text to be concatenated to the project description and makes a mess of the PyPi description

.gitignore

@@ -103,3 +103,4 @@ venv.bak/
 # mypy
 .mypy_cache/
 /msticpy.code-workspace
+/docs/source/_build/**

README.md

@@ -49,7 +49,7 @@ will unpack the contents. The results of each decode/unpack are rechecked for fu
 base64 content and will recurse down up to 20 levels (default can be overridden).
 Output is to a decoded string (for single string input) or a DataFrame (for dataframe input).
 
-[Base64Unpack Notebook](./doc/Base64Unpack.ipynb)
+[Base64Unpack Notebook](./docs/notebooks/Base64Unpack.ipynb)
 
 ### iocextract
 
@@ -69,7 +69,7 @@ You can modify or add to the regular expressions used at runtime.
 
 Output is a dictionary of matches (for single string input) or a DataFrame (for dataframe input).
 
-[Base64Unpack Notebook](./doc/IoCExtract.ipynb)
+[Base64Unpack Notebook](./docs/notebooks/IoCExtract.ipynb)
 
 ### vtlookup
 
@@ -84,7 +84,7 @@ Support IoC Types:
 - DNS Domain
 - IPv4 Address
 
-[VTLookup Notebook](./doc/VirusTotalLookup.ipynb)
+[VTLookup Notebook](./docs/notebooks/VirusTotalLookup.ipynb)
 
 ### geoip
 
@@ -99,7 +99,7 @@ a paid tier will normally get you more accuracy, more detail and
 a higher throughput rate. Maxmind geolite uses a downloadable database,
 while IPStack is an online lookup (API key required).
 
-[GeoIP Lookup Notebook](./doc/GeoIPLookups.ipynb)
+[GeoIP Lookup Notebook](./docs/notebooks/GeoIPLookups.ipynb)
 
 ### eventcluster
 
@@ -110,8 +110,9 @@ items.
 
 The module contains functions to generate clusterable features from
 string data. For example, an administration command that
-does some maintenance on thousands of servers with a commandline such as:<br>
-```
+does some maintenance on thousands of servers with a commandline such as:
+
+```bash
 install-update -hostname {host.fqdn} -tmp:/tmp/{GUID}/rollback
 ```
 
@@ -144,7 +145,7 @@ quicker and easier.
 - nbdisplay - functions that implement common display of things like alerts, events in a slightly more consumable way than print()
 - entityschema - implements entity classes (e.g. Host, Account, IPAddress) used in Log Analytics alerts and in many of these modules. Each entity encaspulates one or more properties related to the entity.
 
-[Notebooks Tools](./doc/NotebookWidgets.ipynb)
+[Notebooks Tools](./docs/notebooks/NotebookWidgets.ipynb)
 
 ## Data sub-package - `data`
 

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+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)

docs/make.bat

@@ -0,0 +1,35 @@
+REM @ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd