Merge pull request #3 from gcermsu/docs

Create documentation and host at readthedocs.io

Author: DakotaHester

.gitignore

@@ -74,5 +74,14 @@ Pipfile.lock
 # rioxarray lock
 .lock
 
-# Planetary Computer signed URLs
-*.pc_signed_url
+
+# Sphinx build output
+docs/_build/
+docs/.doctrees/
+docs/.ipynb_checkpoints/
+# docs/examples
+
+# nbsphinx and Jupyter
+**/.ipynb_checkpoints/
+
+# # Sphinx apidoc autogenerated files (optional, if you regenerate them)

.readthedocs.yml

@@ -0,0 +1,16 @@
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

README.md

@@ -4,7 +4,9 @@ A Python package for seamless querying, downloading, and processing of Microsoft
 
 [![PyPI version](https://img.shields.io/pypi/v/pcxarray.svg)](https://pypi.org/project/pcxarray/)
 [![Downloads](https://pepy.tech/badge/pcxarray)](https://pepy.tech/project/pcxarray)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://pcxarray.readthedocs.io/en/stable/license.html)
+[![Documentation Status](https://readthedocs.org/projects/pcxarray/badge/?version=stable)](https://pcxarray.readthedocs.io/en/stable/?badge=stable)
+![example workflow](https://github.com/gcermsu/pcxarray/actions/workflows/pypi-release.yml/badge.svg)
 [![Open in NBViewer](https://img.shields.io/badge/Open%20in-NBViewer-orange?logo=jupyter)](https://nbviewer.org/github/gcermsu/pcxarray/blob/main/examples/hls_timeseries.ipynb)
 
 ## Overview
@@ -195,7 +197,7 @@ Use `get_pc_collections()` to discover available collections. Note that not all
 
 ## Complete Examples
 
-Explore these comprehensive examples in the [`examples/`](examples/) directory:
+Explore these comprehensive examples in the [`examples/`](examples/) directory of the repository:
 
 - **[`hls_timeseries.ipynb`](examples/hls_timeseries.ipynb)**: Water quality monitoring with HLS data [![Open in NBViewer](https://img.shields.io/badge/Open%20in-NBViewer-orange?logo=jupyter)](https://nbviewer.org/github/gcermsu/pcxarray/blob/main/examples/hls_timeseries.ipynb)
 - **[`naip.ipynb`](examples/naip.ipynb)**: NAIP imagery processing with grid creation [![Open in NBViewer](https://img.shields.io/badge/Open%20in-NBViewer-orange?logo=jupyter)](https://nbviewer.org/github/gcermsu/pcxarray/blob/main/examples/naip.ipynb)
@@ -205,12 +207,7 @@ Explore these comprehensive examples in the [`examples/`](examples/) directory:
 
 ## API Reference
 
-Documentation is currently unavailable, but each function should have descriptive docstrings and full type hints. Use python's built-in `help()` function or IDE tooltips to explore available methods and parameters.
-
-```python
-import pcxarray as pcx
-help(pcx.prepare_data)  # View function signature and docstring
-```
+Documentation can be found at [pcxarray.readthedocs.io](https://pcxarray.readthedocs.io/en/stable/).
 
 ## Known Issues
 

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     = .
+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/_static/gcer_alt.png

@@ -0,0 +1,51 @@
+import os
+import sys
+import shutil
+sys.path.insert(0, os.path.abspath('../src'))
+
+# Copy notebooks into docs/examples before build
+examples_src = os.path.abspath('../examples')
+examples_dst = os.path.abspath('examples')
+shutil.copytree(examples_src, examples_dst, dirs_exist_ok=True)
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'pcxarray'
+copyright = '2025, Mississippi State University'
+author = "GCER Lab @ Mississippi State University"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',  # For Google/Numpy style docstrings
+    'numpydoc',
+    'nbsphinx',  
+    'myst_parser', 
+]
+autodoc_default_options = {
+    'members': True,
+    'undoc-members': True,
+    'show-inheritance': True,
+}
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
+html_static_path = ['_static']
+html_logo = '_static/gcer_alt.png'