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-28598: Fix pipetask command-line utility doc generation. #115

Merged
merged 2 commits into from
Mar 26, 2021
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
13 changes: 6 additions & 7 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@
This configuration only affects single-package Sphinx documentation builds.
"""

from documenteer.sphinxconfig.stackconf import build_package_configs
import lsst.ctrl.mpexec
from documenteer.conf.pipelinespkg import * # noqa: F403, import *


_g = globals()
_g.update(build_package_configs(
project_name='ctrl_mpexec',
version=lsst.ctrl.mpexec.version.__version__))
project = "ctrl_mpexec"
html_theme_options["logotext"] = project # noqa: F405, unknown name
html_title = project
html_short_title = project
doxylink = {}
24 changes: 10 additions & 14 deletions doc/lsst.ctrl.mpexec/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,6 @@ lsst.ctrl.mpexec
.. .. toctree::
.. :maxdepth: 1

.. _lsst.ctrl.pipetask-script:

Command Line Scripts
====================

The `pipetask` command is being ported from an argparse framework to a Click
framework. During development the command implemented using Click is called
`pipetask2`. At some point the current `pipetask` command will be removed and
`pipetask2` will be renamed to `pipetask`.

.. click:: lsst.ctrl.mpexec.cli.pipetask:cli
:prog: pipetask2
:show-nested:

.. _lsst.ctrl.mpexec-contributing:

Contributing
Expand All @@ -45,6 +31,16 @@ You can find Jira issues for this module under the `ctrl_mpexec <https://jira.ls
.. .. toctree::
.. :maxdepth: 1

.. _lsst.ctrl.mpexec-script:

Command Line Scripts
====================

.. toctree::
:maxdepth: 1

pipetask

.. _lsst.ctrl.mpexec-pyapi:

Python API reference
Expand Down
4 changes: 4 additions & 0 deletions doc/lsst.ctrl.mpexec/pipetask.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

.. click:: lsst.ctrl.mpexec.cli.pipetask:cli
:prog: pipetask
:show-nested: