Developing lsst-texmf

Editing the class files

Changes can be made to any of the files in the lsst-texmf repository by submitting a pull request in the normal manner. Travis jobs automatically run when a PR is created to ensure that nothing has been broken and a pull request can only be merged if these checks pass. Please obtain reviews of any non-trivial changes to .cls and .sty files.

If new files are added to or old ones removed from the texmf directory, please remember to run texhash in that directory in order to update the ls-R file. This file is committed to the repository such that end users do not have to remember to update it themselves.

Updating bibliographies

One goal of a shared repository containing the LSST LaTeX files, is to provide a shared source of truth for references to other documents. If a document is being cited that is not part of the current list, a pull request should be made, preferably using a ticket branch related to the main document development. If the automated tests pass, the PR can be self-merged without review. In this way, we can ensure that all documents agree on references without duplication and with minimum overhead. Reminder that author lists in bibliography entries should use and to separate authors thus “William O’Mullane and Tim Jenness”.

For new documents made with sqrbot-jr a file will be created called bibentry.txt which will contain a bib entry for the the document which could be added to the appropriate bibfile.

For older LaTeX documents a script lsstdoc2bib.py exists in the bin folder of lsst-texmf which attempts to get info from the tex macros of the document. Run it with the main file and the meta file like:lsstdoc2bib.py meta.tex DMTN-nnn.tex where DMTN-nnn is the tex of the document you want the entry for. Its not very robust but gives you a start.

Bibliography file organization

  • lsst.bib includes LSST documents (DocuShare documents and technical notes). Any document available on DocuShare should use the @DocuShare bib entry using the document handle as the key in the bib file. In the longer term, this file will be auto-generated from DocuShare and should always be up to date and should not require manual editing.

  • lsst-dm.bib includes LSST Data Management publications (ADS and non-ADS) and presentations. Do not include DocuShare items in this file. Presentations should use a key of form YYYYauthor-meeting.

  • refs_ads.bib includes any reference that can be found on ADS (aside from those in lsst-dm.bib). Entries must be the standard ADS bibtex export and use the ADS Bibcode. This file should be used for arXiv entries obtained from ADS.

  • refs.bib should be used for non-LSST references that can not be located on ADS.

  • books.bib should be used for books that are not indexed by ADS.

%-escaping for Sphinx

Sphinx documents also use lsst-texmf’s bibliographies through sphinxcontrib-bibtex. The Sphinx workflow requires that any non-comment % character be escaped. ADS includes un-escaped % characters in URLs for A&A journal articles, for instance. To work around this for now, ensure that these URLs are escaped (that is: \%). Travis CI is testing bibliographies for Sphinx compatibility.

See DM-11358 for progress towards resolving this issue.

Updating examples and tests

We welcome additional example files to be added to the examples directory and test files to be added to the tests directory. If new features are added to class or style files, it is helpful to add example code that uses these features to allow them to be tested. Once new files are added, ensure that they are built correctly by the Makefile since that file is used to build the tests and examples on Travis. Be sure to document your example in the Examples page.

Contributing documentation

This documentation site is produced by Sphinx from the docs/ repository directory, and published with LSST the Docs to https://lsst-texmf.lsst.io. For more information on writing reStructuredText-formatted documentation, see DM’s reStructuredText Style Guide. You can contribute to the documentation using DM’s normal workflow. When you have pushed a ticket branch to GitHub, you can find a rendered draft at https://lsst-texmf.lsst.io/v. The main site at https://lsst-texmf.lsst.io updates automatically once your PR is merged to master.

Maintaining the Docker distribution

Docker images are automatically published as lsstsqre/lsst-texmf on Docker Hub through Travis CI. Contributors shouldn’t need to worry about updating the Docker distribution.

The following tags are generated through Travis:

  • latest corresponds to master on GitHub.

  • Tags also correspond to git branches and tags on GitHub. The build system converts forward slashes in branch names to dashes in tags. For example, the tickets/DM-10642 Git branch is published on Docker Hub as tickets-DM-10642.

  • travis-N tags correspond to individual Travis CI builds.

The following components are involved in the Docker toolchain:

  • The Dockerfile defines the container. Note that lsst-texmf’s Dockerfile is only concerned with installing lsst-texmf and setting TEXMFHOME. The lsstsqre/lsst-texlive base image provides TeX Live and tools like make and git.

  • The .travis.yml file runs the Docker image build and push in the Travis CI environment.

  • The bin/travis-docker-deploy.sh script tags the images according to the above scheme and pushes those images to Docker Hub.