LSST the Docs Mason: Tool for building LSST documentation
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docker
docs
integration_tests
ltdmason
test_data
tests
.gitattributes
.gitignore
.travis.yml
CHANGELOG.rst
LICENSE
MANIFEST.in
README.rst
manifest_schema.yaml
requirements.txt
setup.cfg
setup.py
versioneer.py

README.rst

LSST the Docs: Mason

Mason is the build tool for LSST software documentation. It's flexible and can run as part of a Travis CI build to upload built documentation to Amazon S3 in coordination with LTD Keeper. Mason can also build documentation for complex multi-repository software projects like the LSST Science Pipelines.

Mason a part of the LSST the Docs (LTD) service for continuous documentation delivery. You can learn more about LTD in our SQR-006 technote.

Installation

Mason is compatible with Python 2.7 and 3.4+. You can get the latest release from PyPI:

pip install ltd-mason

Docs

Read the docs at https://ltd-mason.lsst.io

This documentation describes how to use LTD Mason in Travis-based (single repo) and Jenkins-based (multi repo) documentation builds.


Copyright 2016-2017 Association of Universities for Research in Astronomy, Inc.

License: MIT.