[DM-15472] Create a directive for auto-documenting task configuration - Jira

XML

Word

Printable

Details

Type: Story
Status: Done
Resolution: Done
Fix Version/s: None
Component/s: Stack Documentation and UX
Labels:
- pipelines-docs

Story Points:
16.6
Epic Link:
sqr-f18-stackdocs-1
Team:
SQuaRE

Description

Create a Sphinx directive that automatically documents the configuration for a task. The directive will be included in https://github.com/lsst-sqre/documenteer and used as part of the task topic pages (https://dmtn-030.lsst.io/#task-topic-type).

Attachments

Issue Links

relates to

DM-15489 Research Tasks/Task configuration and prototype documentation architectures

Done

DM-15774 Initial Sphinx-based Task documentation for packages

Done

DM-15821 toctree/index of task topics

Done

DM-11558 pex_config numpydoc conversion and package documentation configuration

Done

DM-15422 First draft of task documentation topic-type

Done

Activity

Hide

Permalink

Jonathan Sick added a comment - 19/Sep/18 2:22 PM

See the pull request for sample code and screenshots

Show

Jonathan Sick added a comment - 19/Sep/18 2:22 PM See the pull request for sample code and screenshots

People

Assignee:: Jonathan Sick

Reporter:: Jonathan Sick

Watchers:: Jonathan Sick

Votes:: 0 Vote for this issue

Watchers:: 1 Start watching this issue

Dates

Created:: 20/Aug/18 9:53 AM

Updated:: 20/Sep/18 2:04 PM

Resolved:: 19/Sep/18 2:22 PM

Jenkins

No builds found.

Data Management