Freeze API docs

.gitignore

@@ -7,6 +7,5 @@ build
 dist
 .vscode
 src/rhalphalib/version.py
-docs/api
 docs/_build
 .nox

docs/api/rhalphalib.plot.rst

@@ -0,0 +1,34 @@
+rhalphalib.plot package
+=======================
+
+.. automodule:: rhalphalib.plot
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Submodules
+----------
+
+rhalphalib.plot.input\_shapes module
+------------------------------------
+
+.. automodule:: rhalphalib.plot.input_shapes
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+rhalphalib.plot.plot\_TF module
+-------------------------------
+
+.. automodule:: rhalphalib.plot.plot_TF
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+rhalphalib.plot.plot\_cov module
+--------------------------------
+
+.. automodule:: rhalphalib.plot.plot_cov
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/api/rhalphalib.rst

@@ -0,0 +1,26 @@
+rhalphalib package
+==================
+
+.. automodule:: rhalphalib
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   rhalphalib.plot
+
+Submodules
+----------
+
+rhalphalib.util module
+----------------------
+
+.. automodule:: rhalphalib.util
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/conf.py

@@ -1,19 +1,24 @@
 from __future__ import annotations
 
+from functools import reduce
 import importlib.metadata
+import inspect
 from typing import Any
+import subprocess
 
 project = "rhalphalib"
 copyright = "2025, rhalphalib developers"
 author = "Nick Smith"
 version = release = importlib.metadata.version("rhalphalib")
+githash = subprocess.check_output(["git", "rev-parse", "HEAD"]).strip().decode("ascii")
 
 extensions = [
     "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
+    "sphinx.ext.linkcode",
     "sphinx_autodoc_typehints",
     "sphinx_copybutton",
     "nbsphinx",
@@ -45,7 +50,7 @@
         },
     ],
     "source_repository": "https://github.com/nsmith-/rhalphalib",
-    "source_branch": "main",
+    "source_branch": "master",
     "source_directory": "docs/",
 }
 
@@ -65,3 +70,20 @@
 ]
 
 always_document_param_types = True
+
+
+def linkcode_resolve(domain, info):
+    if domain != "py":
+        return None
+    if not info["module"]:
+        return None
+    mod = importlib.import_module(info["module"])
+    obj = reduce(getattr, [mod] + info["fullname"].split("."))
+    try:
+        path = inspect.getsourcefile(obj)
+        relpath = path[path.rfind("/src") + 1 :]
+        _, lineno = inspect.getsourcelines(obj)
+    except TypeError:
+        # skip property or other type that inspect doesn't like
+        return None
+    return "http://github.com/nsmith-/rhalphalib/blob/{}/{}#L{}".format(githash, relpath, lineno)

src/rhalphalib/__init__.py

@@ -13,6 +13,7 @@
     NuisanceParameter,
     IndependentParameter,
     DependentParameter,
+    Parameter,
 )
 from .function import (
     BasisPoly,
@@ -36,6 +37,7 @@
     "NuisanceParameter",
     "IndependentParameter",
     "DependentParameter",
+    "Parameter",
     "BasisPoly",
     "BernsteinPoly",
     "DecorrelatedNuisanceVector",

src/rhalphalib/util.py

@@ -91,6 +91,13 @@ def _pairwise_sum(array):
 
 
 def install_roofit_helpers():
+    """Install some nice pythonizations for RooFit
+
+    This is a one-time operation, so it is safe to call multiple times.
+    Some of these helpers are part of more recent ROOT releases, so
+    we check the version and only install them if they are not
+    already present.
+    """
     global ROOFIT_HELPERS_INSTALLED
     if ROOFIT_HELPERS_INSTALLED:
         return