Merge branch 'tickets/DM-41811'

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.3.0
+    hooks:
+      - id: black
+        # It is recommended to specify the latest version of Python
+        # supported by your project here, or alternatively use
+        # pre-commit's default_language_version, see
+        # https://pre-commit.com/#top_level-default_language_version
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        name: isort (python)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.1.8
+    hooks:
+      - id: ruff
+  - repo: https://github.com/numpy/numpydoc
+    rev: "v1.6.0"
+    hooks:
+      - id: numpydoc-validation

doc/.gitignore

@@ -0,0 +1,10 @@
+# Doxygen products
+html
+xml
+*.tag
+*.inc
+doxygen.conf
+
+# Sphinx products
+_build
+py-api

doc/conf.py

@@ -0,0 +1,13 @@
+"""Sphinx configuration file for an LSST stack package.
+
+This configuration only affects single-package Sphinx documentation builds.
+For more information, see:
+https://developer.lsst.io/stack/building-single-package-docs.html
+"""
+
+from documenteer.conf.pipelinespkg import *  # noqa: F403, import *
+
+project = "multiprofit"
+html_theme_options["logotext"] = project  # noqa: F405, unknown name
+html_title = project
+html_short_title = project

doc/index.rst

@@ -0,0 +1,12 @@
+################################
+multiprofit documentation preview
+################################
+
+.. This page is for local development only. It isn't published to pipelines.lsst.io.
+
+.. Link the index pages of package and module documentation directions (listed in manifest.yaml).
+
+.. toctree::
+   :maxdepth: 1
+
+   lsst.multiprofit/index

doc/lsst.multiprofit/index.rst

@@ -0,0 +1,100 @@
+.. py:currentmodule:: lsst.multiprofit
+
+.. _lsst.multiprofit:
+
+#######################
+lsst.multiprofit
+#######################
+
+MultiProFit is a Python astronomical source modelling code. See the README for more information about the package.
+
+.. .. _lsst.multiprofit-using:
+
+.. Using lsst.multiprofit
+.. =============================
+
+.. toctree linking to topics related to using the module's APIs.
+
+.. .. toctree::
+..    :maxdepth: 1
+
+.. _lsst.multiprofit-contributing:
+
+Contributing
+============
+
+``lsst.multiprofit`` is developed at https://github.com/lsst-dm/multiprofit.
+You can find Jira issues for this module through `search <https://jira.lsstcorp.org/issues/?jql=text%20~%20%22multiprofit%22>`_.
+
+.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
+
+.. .. toctree::
+..    :maxdepth: 1
+
+.. _lsst.multiprofit-command-line-taskref:
+
+Task reference
+==============
+
+``lsst.multiprofit`` tasks are implemented in `meas_extensions_multiprofit <https://github.com/lsst-dm/meas_extensions_multiprofit>`_.
+
+Configurations
+--------------
+
+.. lsst-configs::
+   :root: lsst.multiprofit
+   :toctree: configs
+
+.. .. _lsst.multiprofit-scripts:
+
+.. Script reference
+.. ================
+
+.. .. TODO: Add an item to this toctree for each script reference topic in the scripts subdirectory.
+
+.. toctree::
+    :maxdepth: 1
+
+.. _lsst.multiprofit-pyapi:
+
+Python API reference
+====================
+
+.. automodapi:: lsst.multiprofit.asinhstretchsigned
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.componentconfig
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.config
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.fit_bootstrap_model
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.fit_catalog
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.fit_source
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.limits
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.modeller
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.plots
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.priors
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.psfmodel_utils
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.transforms
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.multiprofit.utils
+   :no-inheritance-diagram:

doc/manifest.yaml

@@ -0,0 +1,12 @@
+# Documentation manifest.
+
+# List of names of Python modules in this package.
+# For each module there is a corresponding module doc subdirectory.
+modules:
+  - "lsst.multiprofit"
+
+# Name of the static content directories (subdirectories of `_static`).
+# Static content directories are usually named after the package.
+# Most packages do not need a static content directory (leave commented out).
+# statics:
+#   - "_static/multiprofit"