[NEW] - Full documentation with basic examples and user guide

.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+  requirements: docs/requirements.txt

README.md

@@ -2,3 +2,14 @@
 [![Release](https://github.com/Quasars/pySNOM/actions/workflows/release.yml/badge.svg)](https://github.com/Quasars/pySNOM/actions/workflows/release.yml)
 # pySNOM
 Scanning Near-field Optical Microscopy (SNOM) analysis tools
+
+## Documentation
+
+The documentation uses Sphinx, MyST Markdown, and NumPy-style docstrings:
+
+```console
+python -m pip install -r docs/requirements.txt
+python -m sphinx -b html docs docs/_build/html
+```
+
+The generated site is available at `docs/_build/html/index.html`.

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/custom.css

@@ -0,0 +1,80 @@
+.landing-grid {
+  display: grid;
+  grid-template-columns: repeat(2, minmax(0, 1fr));
+  gap: 1rem;
+  margin: 2rem 0 3rem;
+}
+
+.bd-page-width {
+  max-width: 100rem !important;
+}
+
+.landing-card {
+  display: block;
+  border: 1px solid var(--pst-color-border);
+  border-radius: 0.35rem;
+  padding: 1.25rem 1.4rem;
+  color: var(--pst-color-text-base);
+  background: var(--pst-color-background);
+  transition: border-color 150ms ease, box-shadow 150ms ease,
+    transform 150ms ease;
+}
+
+.landing-card:hover {
+  border-color: var(--pst-color-primary);
+  box-shadow: 0 0.35rem 1rem rgb(0 0 0 / 10%);
+  color: var(--pst-color-text-base);
+  text-decoration: none;
+  transform: translateY(-2px);
+}
+
+.landing-card__logo {
+  display: block;
+  width: 4.5rem;
+  height: 4.5rem;
+  margin-bottom: 1rem;
+  object-fit: contain;
+}
+
+.landing-card h2 {
+  margin: 0.35rem 0 0.5rem;
+  color: var(--pst-color-primary);
+  font-size: 1.25rem;
+}
+
+.landing-card p {
+  margin: 0;
+}
+
+.landing-card__label {
+  color: var(--pst-color-text-muted);
+  font-size: 0.78rem;
+  font-weight: 700;
+  letter-spacing: 0.04em;
+  text-transform: uppercase;
+}
+
+html[data-theme="light"] .highlight-text {
+  margin: 1rem 0 1.5rem;
+  border: none;
+  border-left: 0.2rem solid #c8c8c8;
+  border-radius: 0.35rem;
+  background: #f5f5f5;
+}
+
+html[data-theme="light"] .highlight-text pre {
+  margin: 0;
+  padding: 1rem 1.2rem;
+  color: var(--pst-color-text-base);
+  background: #f5f5f5;
+  font-family: var(--pst-font-family-monospace);
+  font-size: 0.9rem;
+  line-height: 1.55;
+  white-space: pre-wrap;
+}
+
+@media (max-width: 700px) {
+  .landing-grid {
+    grid-template-columns: 1fr;
+  }
+}