[DM-7094] Develop Sphinx configuration for Pipelines Documentation, including MVP HTML/CSS Template - Jira

XML

Word

Printable

Details

Type: Story
Status: Done
Resolution: Done
Fix Version/s: None
Component/s: Stack Documentation and UX
Labels:
- stack-doc-system

Story Points:
4.3
Epic Link:
sqre-f16-doc-pipe-1
Team:
SQuaRE

Description

This ticket will kick-off a pilot implementation of pipelines documentation in Sphinx. Specific goals are

1. Develop template for sphinx-ready doc/ directories in packages (based on SQR-006)
2. Setup a MVP sphinx template that works well with numpydoc and astropy automodsumm. Simply porting astropy’s sphinx template would be pragmatic.
3. documenteer-driven configuration for sphinx.

These will be MVPs, and iterated upon in later tickets that implement sphinx API docs for stack packages.

Attachments

Issue Links

has to be done before

DM-7095 Pilot Sphinx/Breath/Doxygen-generated API docs for daf_base

Done

relates to

DM-7096 Draft Pipelines Documentation Implementation Plan technote

Done

DM-7885 Add “Powered by Fastly” to technotes themes

Invalid

DM-7042 validate_base API refinement

Done

Activity

No work has yet been logged on this issue.

People

Assignee:: Jonathan Sick

Reporter:: Jonathan Sick

Watchers:: Jonathan Sick

Votes:: 0 Vote for this issue

Watchers:: 1 Start watching this issue

Dates

Created:: 02/Aug/16 2:01 PM

Updated:: 23/Dec/16 12:07 PM

Resolved:: 23/Dec/16 12:06 PM

Jenkins

No builds found.

Data Management