PIPE-2738: preserve original docstrings for Sphinx; fix doc rendering issues
Split docstring cleaning: keep original for Sphinx introspection,
clean wrapper only for terminal display. Restores figures, cross-refs,
tables, and code blocks in HTML/PDF documentation.
Also update PDF cover: title to include observatories, author to
"Pipeline Contributors".
PIPE-2738: make pdf link version-contained and use short version on pdf cover
- Copy `taskdocs.pdf` directly into the html/ output bundle in .readthedocs.yaml
- Update `README.rst` to use a relative path for the PDF download link
- Set Sphinx `release` to the short version in `conf.py` to clean up the PDF cover
- Add comments explaining the usage of Sphinx version variables
PIPE-2738: Added SD changes from Kotomi
# Please enter the commit message for your changes. Lines starting
# with '#' will be kept; you may remove them yourself if you want to.
# An empty message aborts the commit.
#
# Author: Remy Indebetouw <remy@virginia.edu>
# Date: Thu Aug 13 22:12:09 2026 -0400
#
# interactive rebase in progress; onto 976da6259c
# Last commands done (4 commands done):
# squash d6ba8f8fcb # forgot an acknowledgement
# reword 5a8029cb26 # changes from Kotomi
# Next commands to do (2 remaining commands):
# pick c28aeed740 PIPE-2738: make pdf link version-contained and use short version on pdf cover
# pick 6804eebfd1 PIPE-2738: preserve original docstrings for Sphinx; fix doc rendering issues
# You are currently editing a commit while rebasing branch 'docs/PIPE-2738-improve-docs-for-main-part3' on '976da6259c'.
#
# Changes to be committed:
# modified: pipeline/hsd/cli/hsd_atmcor.py
# modified: pipeline/hsd/cli/hsd_imaging.py
# modified: pipeline/hsd/cli/hsd_importdata.py
#
# Untracked files:
# unit-results.xml
#
PIPE-2738: Added branding to the ALMA User's guide front page
- Added an acknowledgement and log files
- Added a line to the selfcal weblog page for PL2026
# Please enter the commit message for your changes. Lines starting
# with '#' will be kept; you may remove them yourself if you want to.
# An empty message aborts the commit.
#
# Author: Remy Indebetouw <remy@virginia.edu>
# Date: Thu Aug 13 18:36:36 2026 -0400
#
# interactive rebase in progress; onto 976da6259c
# Last commands done (3 commands done):
# squash 1a8fad2582 # grr. it didnt add these to the previous
# squash d6ba8f8fcb # forgot an acknowledgement
# Next commands to do (3 remaining commands):
# reword 5a8029cb26 # changes from Kotomi
# pick c28aeed740 PIPE-2738: make pdf link version-contained and use short version on pdf cover
# You are currently rebasing branch 'docs/PIPE-2738-improve-docs-for-main-part3' on '976da6259c'.
#
# Changes to be committed:
# new file: docs/source/users_guide/almalogo.png
# new file: docs/source/users_guide/executive_logos.png
# new file: docs/source/users_guide/guide-img001.png
# modified: docs/source/users_guide/index.md
# modified: pipeline/hif/templates/selfcal.mako
#
# Untracked files:
# unit-results.xml
#
