Added Sphinx Doc Files (WIP)

Added files and build system for Sphinx documentation. Work in progress, will add more documentation on functions and quickstart guide.

Author: aramyxt

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     = 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/build/doctrees/environment.pickle

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: c842b575b097273d14d04c5218d4d760
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/doctrees/index.doctree

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7c8d5b4037ca6b2820e899b7d2425c75
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/doctrees/install.doctree

@@ -0,0 +1,23 @@
+.. Pore2Chip documentation master file, created by
+   sphinx-quickstart on Thu Jan  2 09:45:53 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Pore2Chip Documentation
+=======================
+
+**Pore2Chip** is a Python module designed to streamline the process of analyzing X-ray computed tomography (XCT) 
+images of soil and creating 2D micromodel designs based on that analysis. 
+It leverages the power of open-source libraries like OpenPNM, PoreSpy, and drawsvg to extract key information about the soil's 
+porous structure and translate it into a blueprint for microfluidic simulations or physical "lab-on-a-chip" devices developed using additive manufacturing.
+
+.. note::
+
+   This project is under active development.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   install
+

docs/build/html/.buildinfo

@@ -0,0 +1,51 @@
+
+.. Installation
+.. =======================
+
+.. The OpenPNM and PoreSpy libraries are required to analyze XCT images. PoreSpy is used to generate a 
+.. pore network that is used to extract pore size distribution, pore throat size distribution, and pore coordination numbers. 
+.. OpenPNM is used to construct a new 2D pore network that will be used to create the micromodel design.
+
+.. Install using PiP:
+
+.. .. code-block:: console
+        .. $ pip install pore2chip
+
+Installation
+============
+
+The OpenPNM and PoreSpy libraries are required to analyze XCT images. PoreSpy is used to generate a 
+pore network that is used to extract pore size distribution, pore throat size distribution, and pore coordination numbers. 
+OpenPNM is used to construct a new 2D pore network that will be used to create the micromodel design.
+
+Install using PiP:
+
+.. code-block:: console
+
+   $ pip install pore2chip
+
+Install from source:
+
+.. code-block:: console
+
+   $ git clone https://github.com/EMSL-Computing/Pore2Chip.git 
+   $ cd Pore2Chip
+   $ python3 -m build
+   $ python3 -m pip install pore2chip --no-index --find-links dist/
+
+Creating a Conda environment:
+
+.. code-block:: console
+
+   $ conda create -n pore2chip python=3.9
+   $ conda activate pore2chip
+   $ pip install pore2chip
+
+Building a Docker Image with Jupyter Notebook:
+
+.. code-block:: console
+
+   $ git clone https://github.com/EMSL-Computing/Pore2Chip.git 
+   $ cd Pore2Chip
+   $ docker build -t pore2chip
+   $ docker run -p 8888:8888 pore2chip