Merge pull request #83 from lsst-dm/u/womullan/fixformat

 style change only

.github/workflows/ci.yaml

@@ -22,20 +22,19 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: '3.11'
 
       - name: Python install
         run: |
           python -m pip install --upgrade pip
           python -m pip install -r requirements.txt
-          python -m pip install "ltd-conveyor<2.0.0"
           python -m pip install -r milestones/requirements.txt
 
       - name: Build
         shell: bash
         run: |
-          sh updateDate.sh
           make html
+        working-directory: .
 
       - name: Upload
         if: ${{ github.event_name == 'push' }}

Makefile

@@ -1,31 +1,46 @@
-# Makefile for Sphinx documentation
-#
+BUILDDIR="_build"
+.PHONY:
+init:
+	pip install tox pre-commit
+	pre-commit install
+
+.PHONY:
+html: index.rst
+	tox run -e html
+	mv top_milestones.html $(BUILDDIR)/html
+	cp blockschedule.* $(BUILDDIR)/html
+
+.PHONY:
+lint:
+	tox run -e lint,linkcheck
 
-# You can set these variables from the command line.
-SPHINXOPTS    = -n
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = _build
-VENVDIR       = venv
+.PHONY:
+add-author:
+	tox run -e add-author
 
-# 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
+.PHONY:
+sync-authors:
+	tox run -e sync-authors
+
+.PHONY:
+clean:
+	rm -rf _build
+	rm -rf .technote
+	rm -rf .tox
 
-# 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: index.rst help clean html epub changes linkcheck refresh-bib
 
 # assumes pip install of requirement and milestones.requiremetns
 # celeb uses fdue forecast dates
+.PHONY:
 index.rst:  milestones blockschedule.pdf
 	python milestones/milestones.py celeb --inc=Y ; 
+	mv index.rst temp.rst;
+	@echo "======================" > index.rst;
+	@echo "Celebratory Milestones" >> index.rst;
+	@echo "======================" >> index.rst;
+	cat temp.rst >> index.rst;
+	rm temp.rst;
 	@echo ".. image:: blockschedule.png" >> index.rst;
 	@echo "  :alt: Block Schedule" >> index.rst;
 	@echo "" >> index.rst;
@@ -48,46 +63,3 @@ venv:
                 pip install -r milesotnes/requirements.txt; \
         )
 
-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)/*
-	git checkout index.rst
-
-html: index.rst 
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	mv $(BUILDDIR)/html/_static/rubin_logo.png $(BUILDDIR)/html/_static/lsst-logo-dark.svg
-	mv top_milestones.html $(BUILDDIR)/html
-	cp blockschedule.* $(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:
-	mkdir -p lsstbib
-	refresh-lsst-bib -d lsstbib
-	@echo
-	@echo "Commit the new bibliographies: git add lsstbib && git commit -m \"Update bibliographies.\""
-
-
-

acronyms.rst

@@ -11,12 +11,18 @@ COMP	COMPlete
 ComCam	The commissioning camera is a single-raft, 9-CCD camera that will be installed in LSST during commissioning, before the final camera is ready.
 DM	Data Management
 EPO	Education and Public Outreach
+HTML	HyperText Markup Language
 LDM	LSST Data Management (Document Handle)
 LSST	Legacy Survey of Space and Time (formerly Large Synoptic Survey Telescope)
 M1M3	Primary Mirror Tertiary Mirror
 M2	Secondary Mirror
-SC	Science Collaboration
+OCS	Observatory Control System
+PDF	Portable Document Format
+SC	System Commissioning
 SITCOM	System Integration, Test and Commissioning
 SLAC	SLAC National Accelerator Laboratory
+SSP	Solar System Processing
+SV	Science Validation
+TCS	Telescope Control System
 TMA	Telescope Mount Assembly
 ======= ===========

conf.py

@@ -1,32 +1,7 @@
-#!/usr/bin/env python
-#
-# Sphinx configuration file
-# see metadata.yaml in this repo to update document-specific metadata
+# See the Documenteer docs for how to customize conf.py:
+# https://documenteer.lsst.io/technotes/
 
-import datetime
-import os
-from documenteer.sphinxconfig.technoteconf import configure_technote
+from documenteer.conf.technote import *  # noqa F401 F403
 
-html_logo = '_static/rubin_logo.png'
+exclude_patterns.extend(["*.md", "**/*md", ".tox/*", "milestones/*"])
 
-# Ingest settings from metadata.yaml and use documenteer's configure_technote()
-# to build a Sphinx configuration that is injected into this script's global
-# namespace.
-metadata_path = os.path.join(os.path.dirname(__file__), 'metadata.yaml')
-with open(metadata_path, 'r') as f:
-    confs = configure_technote(f)
-
-# Set revision date to the current date.
-# The “true” revision is really set by the version of the data used in the
-# milestones repository, but that's awkward to work with.
-confs['last_revised'] = datetime.datetime.now().strftime("%Y-%m-%d")
-
-g = globals()
-g.update(confs)
-
-
-# Add intersphinx inventories as needed
-# http://www.sphinx-doc.org/en/stable/ext/intersphinx.html
-# Example:
-#
-#     intersphinx_mapping['python'] = ('https://docs.python.org/3', None)

index.rst

@@ -1,35 +1,42 @@
-.. Auto-generated by milestones/milestones.py on Sun Dec 11 19:45:12 2022 - DO NOT EDIT
+======================
+Celebratory Milestones
+======================
+.. Auto-generated by milestones/milestones.py on Mon Jan 22 15:53:54 2024 - DO NOT EDIT
 
 :tocdepth:
 
 Provenance
 ==========
 
-This document was generated based on the contents of the `lsst-dm/milestones <https://github.com/lsst-dm/milestones>`_ repository, version `422a78e8 <https://github.com/lsst-dm/milestones/commit/422a78e8ec3f9ec716d5be125d5481d6082e7170>`_, dated 2022-12-11.
-This corresponds to the status recorded in the project controls system for October 2022.
+This document was generated based on the contents of the `lsst-dm/milestones <https://github.com/lsst-dm/milestones>`_ repository, version `88ac8705 <https://github.com/lsst-dm/milestones/commit/88ac870528ca1004023d8bb9a8fbb5afc971fcce>`_, dated 2023-10-17.
+This corresponds to the status recorded in the project controls system for September 2023.
 
 Top milestones
 ==============
 
-- **2023-01-31** : TMA Handoff to Rubin (T&SC-0400-1730) 
+- **2022-09-30** : EPO Construction Finish (EPOC285)  **Completed 2022-09-30**
 
-- **2023-05-12** : COMP: Camera Pre-Ship Review at SLAC (CAMM8090) 
+- **2023-03-31** : TMA Handoff to Rubin (T&SC-0400-1730)  **Completed 2023-03-31**
 
-- **2023-09-29** : EPO Construction Finish (EPOC285) 
+- **2024-02-21** : COMP: Camera Pre-Ship Review at SLAC (CAMM8090) 
 
-- **2023-12-05** : Camera Ready for Full System AI&T (COMC-060200-20930) 
+- **2024-05-29** : ComCam Reinstalled on TMA (SUMMIT-Oct24-160) 
 
-- **2023-12-21** : Dome Complete (T&SC-0400-0950) 
+- **2024-07-01** : Dome Complete (T&SC-0400-0950) 
 
-- **2024-03-11** : 3-Mirror Optical System Ready for Testing (T&SC-1100-0400) 
+- **2024-07-03** : 3-Mirror Optical System Ready for Testing (T&SC-1100-0400) 
 
-- **2024-07-09** : System First Light (LSST-1520) 
+- **2024-08-28** : Camera Ready for Full System AI&T (COMC-060200-20930) 
 
-- **2024-11-04** : Test report: Final Pipelines Delivery (LDM-503-17a) 
+- **2024-12-11** : LSSTCam Ready for On Sky (First Photon) (SITCOM-122) 
 
-- **2024-11-04** : COMP: Science Validation 2 Data Release Complete (COMC-0654-0430) 
+- **2025-01-24** : System First Light with LSSTCam (LSST-1520) 
 
-- **2024-11-11** : Operation Readiness Review Complete (SITCOM-130) 
+- **2025-05-22** : Test report: Final Pipelines Delivery (LDM-503-17a) 
+
+- **2025-05-22** : COMP: Science Validation Surveys Complete (COMC-0654-0430) 
+
+- **2025-05-29** : Operation Readiness Review Complete (SITCOM-130) 
 
 A public HTML version for embedding is `here <./top_milestones.html>`_.
 
@@ -42,59 +49,57 @@ Supporting milestones
 
 - **2022-09-30** : Citizen Science Commissioning Project running via LSST infrastructure Complete (EPOC304)  **Completed 2022-09-30**
 
-- **2022-10-03** : Completion of the Scheduler (DM-27734) 
-
-- **2022-10-03** : Start SV Data Collection (COMC-0140) 
+- **2022-12-01** : Camera support asmy w/ComCam+PF+Int#1+CCW Installed on Telescope (SITCOM-92)  **Completed 2022-12-01**
 
-- **2022-10-03** : M2 coating decision (SITCOM-127) 
+- **2023-02-28** : Ops rehearsal for data release processing #1 (LDM-503-13)  **Completed 2023-02-28**
 
-- **2022-10-03** : M2 Glass installed on Cell (SITCOM-104) 
+- **2023-06-30** : Completion of the Scheduler (DM-27734)  **Completed 2023-06-30**
 
-- **2022-10-03** : Optical testing on TMA complete (SITCOM-116) 
+- **2023-10-02** : OCS Available on Summit (DM-35987) 
 
-- **2022-11-17** : M2 Installed on Telescope (T&SC-1100-0300) 
+- **2023-10-02** : TCS Demonstrated (DM-35989) 
 
-- **2022-12-20** : COMP:  Camera Ready for Verification Testing (ITC00475_COM) 
+- **2023-10-02** : TMA safe for transition to M1M3 glass mirror (SITCOM-102) 
 
-- **2022-12-28** : Camera support asmy w/ComCam+PF+Int#1+CCW Installed on Telescope (SITCOM-92) 
+- **2023-11-08** : M1M3 cell+Surrogate Dynamic Testing on TMA done (SITCOM-97) 
 
-- **2023-02-07** : M2 Software demonstrated (DM-35988) 
+- **2023-11-09** : ComCam + PF re-Installed on TMA (SITCOM-105) 
 
-- **2023-03-30** : TMA safe for transition to M1M3 glass mirror (SITCOM-102) 
+- **2023-12-01** : Love Contract Complete (LSST4820) 
 
-- **2023-05-05** : M1M3 cell+Surrogate Dynamic Testing on TMA done (SITCOM-97) 
+- **2024-01-17** : COMP: TMA Refrigeration Tests Complete (SUMMIT-3023) 
 
-- **2023-05-31** : OCS Available on Summit (DM-35987) 
+- **2024-03-29** : M2 Software demonstrated (DM-35988) 
 
-- **2023-05-31** : TCS Demonstrated (DM-35989) 
+- **2024-04-04** : LSSTCam Received @ Summit (SUMMIT-2976) 
 
-- **2023-06-07** : LSSTCam Received @ Summit (SUMMIT-2976) 
+- **2024-05-06** : M2 coating decision (SITCOM-127) 
 
-- **2023-07-04** : COMP: TMA Refrigeration Tests Complete (SUMMIT-3023) 
+- **2024-05-06** : M2 Glass installed on Cell (SITCOM-104) 
 
-- **2023-07-17** : ComCam + PF re-Installed on TMA (SITCOM-105) 
+- **2024-05-23** : M2 Installed on Telescope (T&SC-1100-0300) 
 
-- **2023-11-01** : Love Contract Complete (LSST4820) 
+- **2024-07-03** : M1M3 installed on the TMA (SITCOM-110) 
 
-- **2023-12-05** : Ops rehearsal for data release processing #1 (LDM-503-13) 
+- **2024-08-28** : LSSTCam reverification complete (SITCOM-125) 
 
-- **2023-12-05** : LSSTCam reverification complete (SITCOM-125) 
+- **2024-10-17** : LSSTCam Installed on TMA (SITCOM-123) 
 
-- **2024-02-09** : LSSTCam Installed on TMA (SITCOM-123) 
+- **2024-12-04** : LSSTCam Cold (New1135) 
 
-- **2024-03-11** : M1M3 installed on the TMA (SITCOM-110) 
+- **2024-12-27** : Full focal plane readout complete (New1110) 
 
-- **2024-03-29** : LSSTCam Cold (New1135) 
+- **2024-12-30** : Telescope Aligned (New1165) 
 
-- **2024-04-23** : Full focal plane readout complete (New1110) 
+- **2025-01-24** : Solar System Processing pipeline (SSP) available. (DM-AP-17) 
 
-- **2024-05-07** : Telescope Aligned (New1165) 
+- **2025-01-24** : Initial Optical testing on TMA complete (SITCOM-116) 
 
-- **2024-07-09** : Ops rehearsal for data release processing #3 (LDM-503-16) 
+- **2025-03-03** : Start SV Data Collection (COMC-0140) 
 
-- **2024-07-09** : Solar System Processing pipeline available. (DM-AP-17) 
+- **2025-05-22** : Full integration of the Alert Production system within the operational environment. (DM-AP-16) 
 
-- **2024-11-04** : Full integration of the Alert Production system within the operational environment. (DM-AP-16) 
+- **2025-05-29** : Ops rehearsal for data release processing #3 (LDM-503-16) 
 
 .. image:: blockschedule.png
   :alt: Block Schedule