Merge pull request #26 from lsst/tickets/DM-26063

DM-26063 Create a user guide page for alert_packet on pipelines.lsst.io

doc/.gitignore

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

doc/SConscript

@@ -0,0 +1,3 @@
+# -*- python -*-
+from lsst.sconsUtils import scripts
+scripts.BasicSConscript.doc()

doc/conf.py

@@ -0,0 +1,14 @@
+"""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 *
+
+
+project = "alert.packet"
+html_theme_options["logotext"] = project
+html_title = project
+html_short_title = project

doc/index.rst

@@ -0,0 +1,12 @@
+#############################
+alert.packet 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.alert.packet/index

doc/lsst.alert.packet/index.rst

@@ -0,0 +1,41 @@
+.. py:currentmodule:: lsst.alert.packet
+
+.. _lsst.alert.packet:
+
+############
+lsst.alert.packet
+############
+
+.. Paragraph that describes what this Python module does and links to related modules and frameworks.
+
+.. .. _lsst.alert.packet-using:
+
+.. Using lsst.alert.packet
+.. ==================
+
+.. toctree linking to topics related to using the module's APIs.
+
+.. .. toctree::
+..    :maxdepth: 1
+
+.. _lsst.alert.packet-contributing:
+
+Contributing
+============
+
+``lsst.alert.packet`` is developed at https://github.com/lsst/alert_packet.
+You can find Jira issues for this module under the `alert_packet <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20alert_packet>`_ component.
+
+.. 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.alert.packet-command-line-taskref:
+
+Python API reference
+====================
+
+.. automodapi:: lsst.alert.packet
+   :no-main-docstr:
+   :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.alert.packet"
+
+# 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/alert.packet"