Merge pull request #25 from lsst/tickets/DM-13996

tickets/DM-13996: Update doc/ directory for sphinx

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 documenation builds.
+"""
+
+from documenteer.sphinxconfig.stackconf import build_package_configs
+import lsst.meas.extensions.photometryKron
+
+
+_g = globals()
+_g.update(build_package_configs(
+    project_name='meas_extensions_photometryKron',
+    version=lsst.meas.extensions.photometryKron.version.__version__))

doc/index.rst

@@ -0,0 +1,13 @@
+####################################################
+meas_extensions_photometryKron 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
+
+   meas_extensions_photometryKron/index
+   lsst.meas.extensions.photometryKron/index

doc/lsst.meas.extensions.photometryKron/index.rst

@@ -0,0 +1,14 @@
+.. _lsst.meas.extensions_photometryKron:
+
+###################################
+lsst.meas.extensions_photometryKron
+###################################
+
+.. Paragraph that describes what this Python module does and links to related modules and frameworks.
+
+.. Add subsections with toctree to individual topic pages.
+
+Python API reference
+====================
+
+.. .. automodapi:: lsst.meas.extensions_photometryKron

doc/manifest.yaml

@@ -0,0 +1,15 @@
+# Documentation manifest.
+
+# Name of this package
+# Also the name of the package documentation subdirectory.
+package: "meas_extensions_photometryKron"
+
+# List of names of Python modules in this package.
+# For each module there is a corresponding module doc subdirectory.
+modules:
+  - "lsst.meas.extensions_photometryKron"
+
+# Name of the static content directories (subdirectories of `_static`).
+# Static content directories are usually named after the package.
+statics:
+  - "_static/meas_extensions_photometryKron"

doc/meas_extensions_photometryKron/index.rst

@@ -0,0 +1,27 @@
+.. _meas_extensions_photometryKron-package:
+
+.. Title is the EUPS package name
+
+##############################
+meas_extensions_photometryKron
+##############################
+
+.. Add a sentence/short paragraph describing what the package is for.
+
+The ``meas_extensions_photometryKron`` package provides algorithms for Kron photometry.
+
+Project info
+============
+
+Repository
+   https://github.com/lsst/meas_extensions_photometryKron
+
+JIRA component
+   `meas_extensions_photometryKron <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20meas_extensions_photometryKron>`_
+
+Modules
+=======
+
+.. Link to Python module landing pages (same as in manifest.yaml)
+
+- :ref:`lsst.meas.extensions_photometryKron <lsst.meas.extensions_photometryKron>`