Skip to content

Commit

Permalink
Update doc/ directory for sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
parejkoj committed Apr 4, 2018
1 parent c5fb26f commit ac2e027
Show file tree
Hide file tree
Showing 6 changed files with 92 additions and 0 deletions.
10 changes: 10 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Doxygen products
html
xml
*.tag
*.inc
doxygen.conf

# Sphinx products
_build
py-api
13 changes: 13 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -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.obs.sdss


_g = globals()
_g.update(build_package_configs(
project_name='obs_sdss',
version=lsst.obs.sdss.version.__version__))
13 changes: 13 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
##############################
obs_sdss 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

obs_sdss/index
lsst.obs.sdss/index
14 changes: 14 additions & 0 deletions doc/lsst.obs.sdss/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _lsst.obs.sdss:

#############
lsst.obs.sdss
#############

.. 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.obs.sdss
15 changes: 15 additions & 0 deletions doc/manifest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Documentation manifest.

# Name of this package
# Also the name of the package documentation subdirectory.
package: "obs_sdss"

# List of names of Python modules in this package.
# For each module there is a corresponding module doc subdirectory.
modules:
- "lsst.obs.sdss"

# Name of the static content directories (subdirectories of `_static`).
# Static content directories are usually named after the package.
statics:
- "_static/obs_sdss"
27 changes: 27 additions & 0 deletions doc/obs_sdss/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _obs_sdss-package:

.. Title is the EUPS package name
########
obs_sdss
########

.. Add a sentence/short paragraph describing what the package is for.
The ``obs_sdss`` package provides camera descriptions and metadata for LSST DM to operate with Sloan Digital Sky Survey imaging data.

Project info
============

Repository
https://github.com/lsst/obs_sdss

JIRA component
`obs_sdss <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20obs_sdss>`_

Modules
=======

.. Link to Python module landing pages (same as in manifest.yaml)
- :ref:`lsst.obs.sdss <lsst.obs.sdss>`

0 comments on commit ac2e027

Please sign in to comment.