Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-13941 Update doc/ directory for sphinx #55

Merged
merged 1 commit into from
Apr 4, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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.pipe.drivers


_g = globals()
_g.update(build_package_configs(
project_name='pipe_drivers',
version=lsst.pipe.drivers.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 @@
##################################
pipe_drivers 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

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

#################
lsst.pipe.drivers
#################

.. 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.pipe.drivers
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: "pipe_drivers"

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

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

.. Title is the EUPS package name

############
pipe_drivers
############

.. Add a sentence/short paragraph describing what the package is for.

The ``pipe_drivers`` package provides high level task execution and coordination scripts to allow task parallelization.

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

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

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

Modules
=======

.. Link to Python module landing pages (same as in manifest.yaml)

- :ref:`lsst.pipe.drivers <lsst.pipe.drivers>`