diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..ad2c2bb --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,10 @@ +# Doxygen products +html +xml +*.tag +*.inc +doxygen.conf + +# Sphinx products +_build +py-api diff --git a/doc/SConscript b/doc/SConscript new file mode 100644 index 0000000..61b554a --- /dev/null +++ b/doc/SConscript @@ -0,0 +1,3 @@ +# -*- python -*- +from lsst.sconsUtils import scripts +scripts.BasicSConscript.doc() diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..6fb6776 --- /dev/null +++ b/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 diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in new file mode 100644 index 0000000..e69de29 diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..eb15a4a --- /dev/null +++ b/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 diff --git a/doc/lsst.alert.packet/index.rst b/doc/lsst.alert.packet/index.rst new file mode 100644 index 0000000..60e9fe0 --- /dev/null +++ b/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 `_ 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: diff --git a/doc/manifest.yaml b/doc/manifest.yaml new file mode 100644 index 0000000..ec4bf33 --- /dev/null +++ b/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"