-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 287af56
Showing
20 changed files
with
15,210 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
lsstbib/* linguist-generated=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
name: CI | ||
|
||
'on': [push, pull_request, workflow_dispatch] | ||
|
||
jobs: | ||
call-workflow: | ||
uses: lsst-sqre/rubin-sphinx-technote-workflows/.github/workflows/ci.yaml@v1 | ||
with: | ||
handle: sitcomtn-050 | ||
secrets: | ||
ltd_username: ${{ secrets.LTD_USERNAME }} | ||
ltd_password: ${{ secrets.LTD_PASSWORD }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
_build/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Copyright 2022 Association of Universities for Research in Astronomy, Inc. (AURA) |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line. | ||
SPHINXOPTS = -W --keep-going -n | ||
SPHINXBUILD = sphinx-build | ||
PAPER = | ||
BUILDDIR = _build | ||
|
||
# User-friendly check for sphinx-build | ||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) | ||
$(error The '$(SPHINXBUILD)' command was not found. Try 'running pip install -r requirements.txt' to get the necessary Python dependencies.) | ||
endif | ||
|
||
# Internal variables. | ||
PAPEROPT_a4 = -D latex_paper_size=a4 | ||
PAPEROPT_letter = -D latex_paper_size=letter | ||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
# the i18n builder cannot share the environment and doctrees with the others | ||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
|
||
.PHONY: help clean html epub changes linkcheck refresh-bib | ||
|
||
help: | ||
@echo "Please use \`make <target>' where <target> is one of" | ||
@echo " html to make standalone HTML files" | ||
@echo " epub to make an epub" | ||
@echo " linkcheck to check all external links for integrity" | ||
@echo " refresh-bib to update LSST bibliographies in lsstbib/" | ||
|
||
clean: | ||
rm -rf $(BUILDDIR)/* | ||
|
||
html: | ||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
@echo | ||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | ||
|
||
epub: | ||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | ||
@echo | ||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub." | ||
|
||
changes: | ||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | ||
@echo | ||
@echo "The overview file is in $(BUILDDIR)/changes." | ||
|
||
linkcheck: | ||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | ||
@echo | ||
@echo "Link check complete; look for any errors in the above output " \ | ||
"or in $(BUILDDIR)/linkcheck/output.txt." | ||
|
||
refresh-bib: | ||
refresh-lsst-bib -d lsstbib | ||
@echo | ||
@echo "Commit the new bibliographies: git add lsstbib && git commit -m \"Update bibliographies.\"" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
.. image:: https://img.shields.io/badge/sitcomtn--050-lsst.io-brightgreen.svg | ||
:target: https://sitcomtn-050.lsst.io | ||
.. image:: https://github.com/lsst-sitcom/sitcomtn-050/workflows/CI/badge.svg | ||
:target: https://github.com/lsst-sitcom/sitcomtn-050/actions/ | ||
.. | ||
Uncomment this section and modify the DOI strings to include a Zenodo DOI badge in the README | ||
.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.#####.svg | ||
:target: http://dx.doi.org/10.5281/zenodo.##### | ||
######################################################################################################### | ||
Summary of In-Kind Contributions to Rubin Observatory System Integration, Test, and Commissioning Efforts | ||
######################################################################################################### | ||
|
||
SITCOMTN-050 | ||
============ | ||
|
||
This technote summarizes the groups and individuals making in-kind contributions to SIT-Com | ||
|
||
**Links:** | ||
|
||
- Publication URL: https://sitcomtn-050.lsst.io | ||
- Alternative editions: https://sitcomtn-050.lsst.io/v | ||
- GitHub repository: https://github.com/lsst-sitcom/sitcomtn-050 | ||
- Build system: https://github.com/lsst-sitcom/sitcomtn-050/actions/ | ||
|
||
|
||
Build this technical note | ||
========================= | ||
|
||
You can clone this repository and build the technote locally with `Sphinx`_: | ||
|
||
.. code-block:: bash | ||
git clone https://github.com/lsst-sitcom/sitcomtn-050 | ||
cd sitcomtn-050 | ||
pip install -r requirements.txt | ||
make html | ||
.. note:: | ||
|
||
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 https://sitcomtn-050.lsst.io will be automatically rebuilt whenever you push your changes to the ``main`` branch on `GitHub <https://github.com/lsst-sitcom/sitcomtn-050>`_. | ||
|
||
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. | ||
|
||
Using the bibliographies | ||
======================== | ||
|
||
The bibliography files in ``lsstbib/`` are copies from `lsst-texmf`_. | ||
You can update them to the current `lsst-texmf`_ versions with:: | ||
|
||
make refresh-bib | ||
|
||
Add new bibliography items to the ``local.bib`` file in the root directory (and later add them to `lsst-texmf`_). | ||
|
||
.. _Sphinx: http://sphinx-doc.org | ||
.. _DM reStructuredText Style Guide: https://developer.lsst.io/restructuredtext/style.html | ||
.. _this repo: ./index.rst | ||
.. _Conda: http://conda.pydata.org/docs/ | ||
.. _lsst-texmf: https://lsst-texmf.lsst.io |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
To add images, add the image file (png, svg or jpeg preferred) to this | ||
_static/ directory. The reST syntax for adding the image is | ||
|
||
.. figure:: /_static/filename.ext | ||
:name: fig-label | ||
:target: http://target.link/url | ||
|
||
Caption text. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
"""Sphinx configuration. | ||
To learn more about the Sphinx configuration for technotes, and how to | ||
customize it, see: | ||
https://documenteer.lsst.io/technotes/configuration.html | ||
""" | ||
|
||
from documenteer.conf.technote import * # noqa: F401, F403 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
:tocdepth: 1 | ||
|
||
.. sectnum:: | ||
|
||
.. Metadata such as the title, authors, and description are set in metadata.yaml | ||
.. TODO: Delete the note below before merging new content to the main branch. | ||
.. note:: | ||
|
||
**This technote is a work-in-progress.** | ||
|
||
Abstract | ||
======== | ||
|
||
This technote summarizes the groups and individuals making in-kind contributions to SIT-Com | ||
|
||
Add content here | ||
================ | ||
|
||
Add content here. | ||
See the `reStructuredText Style Guide <https://developer.lsst.io/restructuredtext/style.html>`__ to learn how to create sections, links, images, tables, equations, and more. | ||
|
||
.. Make in-text citations with: :cite:`bibkey`. | ||
.. Uncomment to use citations | ||
.. .. rubric:: References | ||
.. | ||
.. .. bibliography:: local.bib lsstbib/books.bib lsstbib/lsst.bib lsstbib/lsst-dm.bib lsstbib/refs.bib lsstbib/refs_ads.bib | ||
.. :style: lsst_aa |
Empty file.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.