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-13878: Confirm that ap_verify's documentation is sphinx-buildable #27

Merged
merged 3 commits into from
Apr 11, 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
7 changes: 0 additions & 7 deletions doc/.gitignore

This file was deleted.

6 changes: 3 additions & 3 deletions doc/SConscript
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# -*- python -*-
from lsst.sconsUtils import scripts
scripts.BasicSConscript.doc()
# -*- python -*-
from lsst.sconsUtils import scripts
scripts.BasicSConscript.doc()
8 changes: 2 additions & 6 deletions doc/ap_verify/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,11 @@ Project info
Repository
https://github.com/lsst-dm/ap_verify

JIRA component
`ap_verify <https://jira.lsstcorp.org/browse/DM/component/14167>`_
Jira component
`ap_verify <https://jira.lsstcorp.org/issues/?jql=project %3D DM AND component %3D ap_verify>`_

Modules
=======

- :ref:`lsst.ap.verify <lsst.ap.verify>`
- :ref:`lsst.ap.verify.measurements <lsst.ap.verify.measurements>`

.. NOTE: Need pid and issuetype
.. _`Create a ticket`: https://jira.lsstcorp.org/secure/CreateIssueDetails!init.jspa?pid=&issuetype=&components=14167

25 changes: 12 additions & 13 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
#!/usr/bin/env python

from documenteer.sphinxconfig.stackconf import build_package_configs

import lsst.ap.verify

_g = globals()
_g.update(build_package_configs(
project_name="ap_verify",
copyright="2017 Association of Univerities for "
"Research in Astronomy, Inc.",
version=lsst.ap.verify.version.__version__))

"""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.ap.verify

_g = globals()
_g.update(build_package_configs(
project_name="ap_verify",
version=lsst.ap.verify.version.__version__))
5 changes: 4 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@
ap_verify 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

ap_verify/index.rst
lsst.ap.verify/index.rst
lsst.ap.verify.measurements/index.rst

1 change: 0 additions & 1 deletion doc/lsst.ap.verify.measurements/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ Python API reference
====================

.. automodapi:: lsst.ap.verify.measurements

2 changes: 1 addition & 1 deletion doc/lsst.ap.verify/command-line-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Required arguments are :option:`--dataset`, :option:`--id`, and exactly one of :

``--output`` may not be used with the :option:`--rerun` argument.

See :doc:`command-line-task-data-repo-howto` for background.
See :ref:`command-line-task-data-repo-howto` for background.

.. TODO: Rework or remove --rerun (DM-13492)

Expand Down
1 change: 0 additions & 1 deletion doc/lsst.ap.verify/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,3 @@ Python API reference
====================

.. automodapi:: lsst.ap.verify

13 changes: 11 additions & 2 deletions doc/manifest.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# Documentation manifest.

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

# List of names of Python modules in this package.
# For each module there is a corresponding module doc subdirectory.
modules:
- "lsst.ap.verify"
- "lsst.ap.verify.measurements"
statics:
- "_static/ap_verify"

# Name of the static content directories (subdirectories of `_static`).
# Static content directories are usually named after the package.
# statics:
# - "_static/ap_verify"
5 changes: 0 additions & 5 deletions doc/requirements.txt

This file was deleted.

5 changes: 0 additions & 5 deletions doc/single-package.sh

This file was deleted.