Merge pull request #81 from straithe/addDocumentationSetup

Add initial Packetry documentation kit

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 @@
+@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

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx==7.2.6
+sphinx_rtd_theme==1.3.0
+readthedocs-sphinx-search==0.3.1

docs/source/conf.py

@@ -0,0 +1,35 @@
+import sphinx_rtd_theme
+
+extensions = [
+    'sphinx_rtd_theme'
+]
+
+# -- Project information -----------------------------------------------------
+
+project = 'Packetry'
+copyright = '2023, Great Scott Gadgets'
+author = 'Great Scott Gadgets'
+
+version = ''
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+  'sphinx.ext.autodoc'
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build']
+source_suffix = '.rst'
+master_doc = 'index'
+language = None
+exclude_patterns = []
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+# run pip install sphinx_rtd_theme if you get sphinx_rtd_theme errors
+html_theme = "sphinx_rtd_theme"
+html_css_files = ['status.css']

docs/source/index.rst

@@ -0,0 +1,9 @@
+======================
+Documentation
+======================
+
+.. toctree::
+  :maxdepth: 2
+  :caption: User Documentation
+
+  introToPacketry

docs/source/introToPacketry.rst

@@ -0,0 +1,5 @@
+========
+Packetry
+========
+
+A fast, intuitive USB 2.0 protocol analysis application for use with LUNA.