DM-28328: Enable lsstsw build of documentation

.github/workflows/ci.yaml

@@ -0,0 +1,12 @@
+name: Empty check for branch protection
+
+on:
+  - push
+  - pull_request
+
+jobs:
+
+  null_check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2

conf.py

@@ -1,37 +1,21 @@
 """Sphinx configurations for pipeline_lsst_io.
 
-These configurations are centrally defined in Documenteer
-(https://github.com/lsst-sqre/documenteer).
+These configurations are centrally defined in Documenteer:
+https://documenteer.lsst.io/pipelines/configuration.html
 """
 
-from documenteer.sphinxconfig.stackconf import \
-    build_pipelines_lsst_io_configs
+from documenteer.conf.pipelines import *  # noqa: F403
 
 
-globals().update(build_pipelines_lsst_io_configs(
-    project_name='LSST Science Pipelines',
-))
+project_name = "LSST Science Pipelines"
+html_theme_options["logotext"] = project_name  # noqa: F405
+html_title = project_name
+html_short_title = project_name
 
-# Patch EUPS tag subsitutions
-rst_epilog = """
 
-.. |eups-tag| replace:: v21_0_0
-.. |eups-tag-mono| replace:: ``v21_0_0``
-.. |eups-tag-bold| replace:: **v21_0_0**
-"""
-
-# Patch EUPS and Git tag context for Jinja templating
-jinja_contexts = {
-    "default": {
-        "release_eups_tag": "v21_0_0",
-        "release_git_ref": "21.0.0",
-        "version": "v21_0_0",
-        "release": "v21_0_0",
-        "scipipe_conda_ref": "21.0.0",
-        "pipelines_demo_ref": "21.0.0",
-        "newinstall_ref": "21.0.0",
-    }
-}
-
-import matplotlib.sphinxext.plot_directive
-extensions.remove(matplotlib.sphinxext.plot_directive.__name__)
+def setup(app):
+    # Undo the automodapi autodoc enhancements that are incompatible with
+    # pybind11 properties. Essentially this restores the built-in getattr
+    # as the attr getter for "type" rather than
+    # https://github.com/astropy/sphinx-automodapi/blob/b68a5f3c6805d7c5d0eaa55fff1ff84cc671baf0/sphinx_automodapi/autodoc_enhancements.py#L15
+    app.add_autodoc_attrgetter(type, getattr)

releases/v21_0_0.rst

@@ -57,15 +57,15 @@ Major New Features
 Beta release of Generation 3 Middleware
 ---------------------------------------
 
-Reaching schema stability in this release, the Gen3 butler can now support Science Pipelines development. See :ref:`release-v21-0-0-deprecate-gen2` for more information on the planned deprecation of Generation 2 middleware. Interested parties may find more info at :ref:`daf_butler <lsst.daf_butler>` and :ref:`pipe_base <lsst.pipe_base>`.
+Reaching schema stability in this release, the Gen3 butler can now support Science Pipelines development. See :ref:`release-v21-0-0-deprecate-gen2` for more information on the planned deprecation of Generation 2 middleware. Interested parties may find more info at :ref:`daf_butler <lsst.daf.butler>` and :ref:`pipe_base <lsst.pipe.base>`.
 A general release of Generation 3 Middleware is expected with the next release v22.0.0.
 
 .. _release-v21-0-0-kht:
 
 Task to mask streak-like artifacts
 ----------------------------------
 
-This release adds the `MaskStreaksTask` to :ref:`pipe_tasks <lsst.pipe_tasks>`, which finds and masks streaks and other straight lines in image data.
+This release adds the `MaskStreaksTask` to :ref:`pipe_tasks <lsst.pipe.tasks>`, which finds and masks streaks and other straight lines in image data.
 It uses the Kernel Hough Transform (KHT) `(Fernandes and Oliveira 2007) <https://doi.org/10.1016/j.patcog.2007.04.003>`_ implemented in the `kht <https://github.com/lsst/kht>`_, package which was also added to the Science Pipelines.
 It can be turned on during coaddition with `CompareWarpAssembleCoaddTask` with the config parameter `doFilterMorphological`.
 
@@ -130,9 +130,9 @@ For more information, refer to :jira:`RFC-736`.
 .. _release-v21-0-0-pipelines_check:
 
 Addition of the pipelines_check package
------------------------------------
+---------------------------------------
 
-The new :ref:`pipelines_check <lsst.pipelines_check>` package replaces `lsst_dm_stack_demo`, which relied on the now :ref:`release-v21-0-0-remove-obs_sdss<removed obs_sdss>`. This new package demonstrates the processing of a single CCD with the Science Pipelines. It contains input files and astrometric reference catalogs needed to process the data from a single HSC detector. Its main purpose is to check that the pipeline infrastructure is working correctly.
+The new `pipelines_check` package replaces `lsst_dm_stack_demo`, which relied on the now :ref:`removed obs_sdss<release-v21-0-0-remove-obs_sdss>`. This new package demonstrates the processing of a single CCD with the Science Pipelines. It contains input files and astrometric reference catalogs needed to process the data from a single HSC detector. Its main purpose is to check that the pipeline infrastructure is working correctly.
 
 .. _release-v21-0-0-remove-obs_sdss:
 

ups/eupspkg.cfg.sh

@@ -0,0 +1,25 @@
+build() {
+    # macOS SIP swallows DYLD_LIBRARY_PATH so export the duplicate in
+    # LSST_LIBRARY_PATH
+    if [[ -z $DYLD_LIBRARY_PATH ]]; then
+        export DYLD_LIBRARY_PATH=$LSST_LIBRARY_PATH
+    fi
+    stack-docs build
+}
+
+install() {
+    clean_old_install
+    mkdir -p "$PREFIX"
+    cp -a \
+        _build.log \
+        _build.sh \
+        _build.tags \
+        conf.py \
+        COPYRIGHT \
+        LICENSE \
+        README.md "$PREFIX"
+    cd "$reldir"
+    if [[ -d "ups" && ! -d "$PREFIX/ups" ]]; then
+        install_ups
+    fi
+}