Build docs

.gitignore

@@ -70,6 +70,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/build/
+docs/docs-html.tar.xz
 
 # PyBuilder
 target/

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/docs-html.README.md

@@ -0,0 +1,19 @@
+To build and preview the documentation locally:
+
+1. Install the documentation dependencies (Sphinx and the configured extensions). For example:
+
+   ```bash
+   pip install sphinx nbsphinx
+   ```
+
+   or install the full project environment using the provided `environment.yml`.
+
+2. From the repository root, build the HTML output:
+
+   ```bash
+   sphinx-build -b html docs/source docs/build/html
+   ```
+
+   You can also run `make html` from inside the `docs/` directory.
+
+3. Open `docs/build/html/index.html` in your browser to explore the rendered site.

docs/source/_static/.gitkeep

@@ -0,0 +1 @@
+Placeholder to keep _static tracked.

docs/source/_templates/.gitkeep

@@ -0,0 +1 @@
+Placeholder to keep _templates tracked.

docs/source/api.rst

@@ -0,0 +1,8 @@
+API Reference
+=============
+
+.. automodule:: pylabianca
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

docs/source/changelog.rst

@@ -0,0 +1,5 @@
+Changelog
+=========
+
+See the project's ``whats_new.md`` for the complete changelog.
+

docs/source/conf.py

@@ -0,0 +1,53 @@
+# 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
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+project = 'pylabianca'
+copyright = '2025, pylabianca developers'
+author = 'pylabianca developers'
+
+version = '0.4'
+release = '0.4.dev0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'nbsphinx',
+]
+
+# Mock heavy optional dependencies so autodoc can run without them
+autodoc_mock_imports = [
+    'numpy',
+    'scipy',
+    'matplotlib',
+    'pandas',
+    'scikit-learn',
+    'sklearn',
+    'borsar',
+    'h5io',
+    'h5py',
+    'xlrd',
+    'xarray',
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,16 @@
+.. pylabianca documentation master file, created by
+   sphinx-quickstart on Wed Aug 13 10:05:56 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+pylabianca documentation
+========================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   tutorials
+   api
+   changelog
+

docs/source/tutorials.rst

@@ -0,0 +1,5 @@
+Tutorials
+=========
+
+Tutorial-style guides for using ``pylabianca`` will live here.
+