Skip to content
Science Pipelines Documentation Design
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


Technote website Travis build status doi:10.5281/zenodo.228174

DMTN-030 Science Pipelines Documentation Design

A design discussion and implementation plan for the documentation project, including information design and topic templates.

View this technote at or see a preview of the current version in this repo.

Build this technical note

You can clone this repository and build the technote locally with Sphinx

git clone
cd dmtn-030
pip install -r requirements.txt
make html


In a Conda environment, pip install -r requirements.txt doesn't work as expected. Instead, pip install the packages listed in requirements.txt individually.

The built technote is located at _build/html/index.html.

Editing this technical note

You can edit the index.rst file, which is a reStructuredText document. The DM reStructuredText Style Guide is a good resource for how we write reStructuredText.

Remember that images and other types of assets should be stored in the _static/ directory of this repository. See _static/README.rst for more information.

The published technote at will be automatically rebuilt whenever you push your changes to the master branch on GitHub.

Updating metadata

This technote's metadata is maintained in metadata.yaml. In this metadata you can edit the technote's title, authors, publication date, etc.. metadata.yaml is self-documenting with inline comments.

Copyright 2016, 2017 Association of Universities for Research in Astronomy

This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit

You can’t perform that action at this time.