[DM-21497] Science Pipelines and Project Documentation Improvements - Jira

XML

Word

Printable

Details

Type: Epic
Status: Done
Resolution: Done
Fix Version/s: None
Component/s: None
Labels:
None

Epic Name:
sqre-f19-doceng-2
Story Points:
40
WBS:
1.02C.10.02
Team:
SQuaRE
Cycle:
Fall 2019

Description

This epic oversees infrastructure improvements to documentation builds for piplines.lsst.io and related software projects. The main goal is to integrate C++ reference documentation into pipelines.lsst.io. Secondarily this epic will address ad hoc requests to improve infrastructure for project documentation as they come up.

Attachments

Stories in Epic (Custom Issue Matrix)

Key	Summary	Story Points	Assignee	Status
~~DM-22461~~	Create Sphinx "autocppapi" extension in Documenteer	3.6	Jonathan Sick	Done
~~DM-22572~~	Fix script insertion in lsst-sphinx-bootstrap-theme for Sphinx 2.0	0.7	Jonathan Sick	Done
~~DM-22524~~	Port 19.0.x branch to master of pipelines_lsst_io	0.4	Jonathan Sick	Done
~~DM-22520~~	Document topic support for pipeline tasks	1	Jonathan Sick	Done
~~DM-22500~~	Trial generating C++ documentation for pipelines.lsst.io using "exhale"	3.9	Jonathan Sick	Done
~~DM-22499~~	Trial generating C++ documentation for pipelines.lsst.io using Breathe's breathe-apidoc tool	2.4	Jonathan Sick	Done
~~DM-22537~~	Update pyyaml.load usage in documenteer 0.4.x and 0.5.x	0.5	Jonathan Sick	Done
~~DM-22533~~	Update documenteer with compatibility for Sphinx >= 2.0	1.9	Jonathan Sick	Done
~~DM-22698~~	Run stack-wide Doxygen builds from Documenteer, replacing makeDocs and create_xlinkdocs.sh	6.5	Jonathan Sick	Done
~~DM-22717~~	Add mypy-based static type checking to Documenteer	1.4	Jonathan Sick	Done
~~DM-23094~~	Implement C++ reference documentation for pipelines.lsst.io using "Doxylink"	6.8	Jonathan Sick	Done
~~DM-22101~~	Update form of AURA copyright statement	0.4	Jonathan Sick	Done
~~DM-22131~~	Give tutorial on docs for November 2019 DM Bootcamp	4.1	Jonathan Sick	Done
~~DM-21719~~	DDS packages need some extra env vars to run tests	1	Jonathan Sick	Done
~~DM-21718~~	Consider eliminating the ups cfg file for a pure python package	0.5	Jonathan Sick	Done
~~DM-21708~~	Drop the "example_project" project from lsst/templates	0.2	Jonathan Sick	Done
~~DM-21707~~	templates CI strategy does not detect untracked files	1.4	Jonathan Sick	Done
~~DM-21791~~	Update pipelines.lsst.io Getting Started tutorial because of ci_hsc split	0.7	Jonathan Sick	Done
~~DM-21842~~	Fix "TSTN" series ID in technote_rst's templatekit.yaml	0.2	Jonathan Sick	Done
~~DM-20866~~	Fix package-docs recursion depth error from rebuilds	1.4	Jonathan Sick	Done
~~DM-20839~~	Fix version switcher for Sphinx technotes in non-main editions	0.5	Jonathan Sick	Done
~~DM-21528~~	Escape quotes in Jinja variables being inserted into technote, and other, templates	1.8	Jonathan Sick	Done
~~DM-11760~~	Update LTD Keeper's Cloud SQL Proxy to the latest (1.10) release	1.4	Jonathan Sick	Done

Activity

Ascending order - Click to sort in descending order

No builds found.

Frossie Economou created issue - 02/Oct/19 5:31 PM

Jonathan Sick made changes - 04/Oct/19 3:58 PM

Field	Original Value	New Value
Assignee		Jonathan Sick [ jsick ]

Jonathan Sick made changes - 04/Oct/19 4:00 PM

Epic Child

DM-18435 [ 242890 ]

Jonathan Sick made changes - 04/Oct/19 4:00 PM

Epic Child

DM-20804 [ 369483 ]

Jonathan Sick made changes - 04/Oct/19 4:00 PM

Epic Child

~~DM-20462~~ [ 344461 ]

Jonathan Sick made changes - 04/Oct/19 4:01 PM

Epic Child

~~DM-20463~~ [ 344465 ]

Jonathan Sick made changes - 04/Oct/19 4:01 PM

Epic Child

~~DM-20465~~ [ 344470 ]

Jonathan Sick made changes - 04/Oct/19 4:01 PM

Epic Child

~~DM-20466~~ [ 344471 ]

Jonathan Sick made changes - 04/Oct/19 4:02 PM

Epic Child

~~DM-20467~~ [ 344474 ]

Jonathan Sick made changes - 04/Oct/19 4:02 PM

Epic Child

~~DM-20455~~ [ 343544 ]

Jonathan Sick made changes - 04/Oct/19 4:02 PM

Epic Child

~~DM-20674~~ [ 361303 ]

Jonathan Sick made changes - 04/Oct/19 4:02 PM

Epic Child

~~DM-20839~~ [ 375560 ]

Jonathan Sick made changes - 04/Oct/19 4:03 PM

Epic Child

DM-20840 [ 375569 ]

Jonathan Sick made changes - 04/Oct/19 4:03 PM

Epic Child

~~DM-20866~~ [ 376932 ]

Jonathan Sick made changes - 06/Oct/19 10:29 PM

Epic Child

~~DM-21528~~ [ 424341 ]

Jonathan Sick made changes - 09/Oct/19 1:59 PM

Status

To Do [ 10001 ]

In Progress [ 3 ]

Jonathan Sick made changes - 09/Oct/19 2:03 PM

Epic Child

~~DM-21707~~ [ 424599 ]

Jonathan Sick made changes - 09/Oct/19 2:07 PM

Epic Child

~~DM-21708~~ [ 424600 ]

Frossie Economou made changes - 09/Oct/19 4:20 PM

Story Points

Jonathan Sick made changes - 10/Oct/19 5:33 PM

Epic Child

~~DM-21718~~ [ 424625 ]

Jonathan Sick made changes - 10/Oct/19 7:10 PM

Epic Child

~~DM-21719~~ [ 424626 ]

Jonathan Sick made changes - 21/Oct/19 6:45 PM

Epic Child

~~DM-21842~~ [ 425098 ]

Jonathan Sick made changes - 05/Nov/19 1:00 PM

Epic Child

~~DM-22101~~ [ 425818 ]

Jonathan Sick made changes - 07/Nov/19 6:03 PM

Epic Child

~~DM-22131~~ [ 426041 ]

Jonathan Sick made changes - 13/Nov/19 3:09 PM

Epic Child

DM-22206 [ 426345 ]

Jonathan Sick made changes - 13/Nov/19 8:10 PM

Epic Child

~~DM-22209~~ [ 426381 ]

Krzysztof Findeisen made changes - 14/Nov/19 6:40 PM

Epic Child

~~DM-22209~~ [ 426381 ]

Jonathan Sick made changes - 14/Nov/19 6:42 PM

Epic Child

~~DM-11760~~ [ 34216 ]

Jonathan Sick made changes - 14/Nov/19 9:05 PM

Epic Child

~~DM-21791~~ [ 424787 ]

Jonathan Sick made changes - 03/Dec/19 7:41 PM

Epic Child

DM-19574 [ 271753 ]

Jonathan Sick made changes - 03/Dec/19 8:01 PM

Epic Child

~~DM-22461~~ [ 427233 ]

Jonathan Sick made changes - 05/Dec/19 9:31 PM

Epic Child

~~DM-22499~~ [ 427359 ]

Jonathan Sick made changes - 05/Dec/19 9:35 PM

Epic Child

~~DM-22500~~ [ 427360 ]

Jonathan Sick made changes - 06/Dec/19 9:11 PM

Epic Child

~~DM-22520~~ [ 427394 ]

Jonathan Sick made changes - 09/Dec/19 2:53 PM

Epic Child

~~DM-22524~~ [ 427417 ]

Jonathan Sick made changes - 09/Dec/19 7:44 PM

Epic Child

~~DM-22533~~ [ 427437 ]

Jonathan Sick made changes - 09/Dec/19 9:52 PM

Epic Child

~~DM-22537~~ [ 427446 ]

Jonathan Sick made changes - 11/Dec/19 7:39 PM

Epic Child

~~DM-22572~~ [ 427583 ]

Jonathan Sick made changes - 18/Dec/19 7:37 PM

Epic Child

~~DM-22698~~ [ 427905 ]

Jonathan Sick made changes - 19/Dec/19 6:40 PM

Epic Child

~~DM-22717~~ [ 427971 ]

Jonathan Sick made changes - 07/Jan/20 7:01 PM

Epic Child

DM-21228 [ 413338 ]

Jonathan Sick made changes - 07/Jan/20 7:04 PM

Epic Child

DM-21228 [ 413338 ]

Jonathan Sick made changes - 16/Jan/20 7:43 PM

Epic Child

~~DM-23094~~ [ 428980 ]

Jonathan Sick made changes - 02/Mar/20 7:06 PM

Epic Child

DM-18435 [ 242890 ]

Jonathan Sick made changes - 02/Mar/20 7:06 PM

Epic Child

DM-19574 [ 271753 ]

Jonathan Sick made changes - 02/Mar/20 7:07 PM

Epic Child

DM-20804 [ 369483 ]

Jonathan Sick made changes - 02/Mar/20 7:07 PM

Epic Child

DM-22206 [ 426345 ]

Jonathan Sick made changes - 02/Mar/20 7:08 PM

Epic Child

DM-20840 [ 375569 ]

Jonathan Sick made changes - 02/Mar/20 7:10 PM

Epic Child

~~DM-20462~~ [ 344461 ]

Jonathan Sick made changes - 02/Mar/20 7:11 PM

Epic Child

~~DM-20463~~ [ 344465 ]

Jonathan Sick made changes - 02/Mar/20 7:11 PM

Epic Child

~~DM-20465~~ [ 344470 ]

Jonathan Sick made changes - 02/Mar/20 7:11 PM

Epic Child

~~DM-20466~~ [ 344471 ]

Jonathan Sick made changes - 02/Mar/20 7:12 PM

Epic Child

~~DM-20467~~ [ 344474 ]

Jonathan Sick made changes - 02/Mar/20 7:13 PM

Epic Child

~~DM-20455~~ [ 343544 ]

Jonathan Sick made changes - 02/Mar/20 7:13 PM

Epic Child

~~DM-20674~~ [ 361303 ]

Jonathan Sick made changes - 02/Mar/20 7:13 PM

Status

In Progress [ 3 ]

In Review [ 10004 ]

Jonathan Sick made changes - 02/Mar/20 7:14 PM

Status

In Review [ 10004 ]

In Progress [ 3 ]

Jonathan Sick made changes - 02/Mar/20 7:14 PM

Status	In Progress [ 3 ]	In Review [ 10004 ]
Reviewers		Frossie Economou [ frossie ]

Jonathan Sick made changes - 02/Mar/20 11:06 PM

Status

In Review [ 10004 ]

In Progress [ 3 ]

Jonathan Sick made changes - 02/Mar/20 11:09 PM

Description

Hide

Permalink

Jonathan Sick added a comment - 02/Mar/20 11:15 PM

The main product of this epic is that documenteer, in 0.6, now performs the entire Doxygen build. We no longer require lsstDoxygen and sconsUtils to build the Doxygen C++ documentation. After evaluating multiple off-the-shelf options (including Breathe and Exhale), we found that none of those methods could yield a C++ reference that was as usable as the HTML output of Doxygen itself. Thus we now include the full Doxygen C++ reference build as a subsite of the Sphinx-based pipelines.lsst.io build. We've build an extension into Documenteer, autocppapi that lets us list and link into the C++ reference from each module homepage. With this, the C++ documentation experience is as close as possible to the Python documentation one.

Show

Jonathan Sick added a comment - 02/Mar/20 11:15 PM The main product of this epic is that documenteer, in 0.6, now performs the entire Doxygen build. We no longer require lsstDoxygen and sconsUtils to build the Doxygen C++ documentation. After evaluating multiple off-the-shelf options (including Breathe and Exhale), we found that none of those methods could yield a C++ reference that was as usable as the HTML output of Doxygen itself. Thus we now include the full Doxygen C++ reference build as a subsite of the Sphinx-based pipelines.lsst.io build. We've build an extension into Documenteer, autocppapi that lets us list and link into the C++ reference from each module homepage. With this, the C++ documentation experience is as close as possible to the Python documentation one.

Jonathan Sick made changes - 02/Mar/20 11:15 PM

Status

In Progress [ 3 ]

In Review [ 10004 ]

Hide

Permalink

Frossie Economou added a comment - 04/Jun/20 9:23 PM

(oversightr, this epic should have been marked as complete last cycle as work was done on time)

Show

Frossie Economou added a comment - 04/Jun/20 9:23 PM (oversightr, this epic should have been marked as complete last cycle as work was done on time)

Frossie Economou made changes - 04/Jun/20 9:23 PM

Status

In Review [ 10004 ]

Reviewed [ 10101 ]

Frossie Economou made changes - 04/Jun/20 9:23 PM

Resolution		Done [ 10000 ]
Status	Reviewed [ 10101 ]	Done [ 10002 ]

People

Assignee:: Jonathan Sick

Reporter:: Frossie Economou

Reviewers:: Frossie Economou

Watchers:: Frossie Economou, Jonathan Sick

Votes:: 0 Vote for this issue

Watchers:: 2 Start watching this issue

Dates

Created:: 02/Oct/19 5:31 PM

Updated:: 04/Jun/20 9:23 PM

Resolved:: 04/Jun/20 9:23 PM

Jenkins

No builds found.

Data Management

Details

Description

Attachments

Stories in Epic (Custom Issue Matrix)

Activity

People

Dates

Jenkins