This repository contains the base source material for the LSST DM Developer Guide, http://developer.lsst.io.

Documentation is written in reStructuredText, built using Sphinx, and hosted by readthedocs.org. Changes to the master branch are automatically deployed to http://developer.lsst.io.

See the [Writing Documentation]http://developer.lsst.io/en/latest/docs/rst_styleguide.html) section of the Developer Guide for an overview of writing reStructuredText.

Since this is a Git repository, we recommend following the standard DM development workflow with JIRA tickets, ticket branches, and code review. For very small changes the review process can be by-passed, through review is tremendously beneficial for larger changes. Formally there is not requirement to review documentation changes.

You can get the source for the LSST DM Developer Guide by cloning the GitHub repo.

git clone https://github.com/lsst-sqre/dm_dev_guide.git
cd dm_dev_guide

Create a Python virtual environment for this project using your tool of choice: virtualenvwrapper or pyvenv (for Python 3).

Install Python dependencies by running

pip install -r requirements.txt

Compile the HTML by running

make html

The site will be built in the _build/html directory.

Copyright 2015-2016 AURA/LSST