PIPE-2738: dynamically strip Sphinx markup from task docstrings for terminal users
Updated `cli_wrapper` to automatically scrub Sphinx-specific reST directives
from task docstrings at runtime. This ensures that users running `help()` or `?`
in interactive environments (like IPython or casashell) see clean, readable
plain text instead of raw markup.
Specifically, this strips:
- Cross-reference roles (e.g., `:func:` -> ``` `func_name` ```)
- `.. figure::` blocks (retaining only the caption)
- `.. list-table::` blocks (retaining only the title and list items)
- `.. code-block::` directives
PIPE-2738: Did a readthrough of all hifa_; added back in some description that I thought was important. Also tried to check Kotomi's changes ~Aug 3 in the PLUG, that they got transferred correctly, but those should be double-checked.
# 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 16:13:47 2026 -0400
#
# interactive rebase in progress; onto 64967c159b
# Last commands done (2 commands done):
# pick 7fa0e71b65 PIPE-2738: Update docs badge to reference pixi-based build workflow
# reword 547e325bc6 # did a readthrough of all hifa_; added back in some description that I thought was important. Also tried to check Kotomi's changes ~Aug 3 in the PLUG, that they got transferred correctly, but those should be double-checked.
# Next command to do (1 remaining command):
# pick a5702e6c0d PIPE-2738: dynamically strip Sphinx markup from task docstrings for terminal users
# You are currently editing a commit while rebasing branch 'docs/PIPE-2738-improve-docs-for-main-part3' on '64967c159b'.
#
# Changes to be committed:
# modified: pipeline/hifa/cli/hifa_bandpass.py
# modified: pipeline/hifa/cli/hifa_gfluxscale.py
# modified: pipeline/hifa/cli/hifa_renorm.py
# modified: pipeline/hifa/cli/hifa_tsysflagcontamination.py
# modified: pipeline/hifa/cli/hifa_wvrgcal.py
# modified: pipeline/hifa/cli/hifa_wvrgcalflag.py
# modified: pipeline/hsd/cli/hsd_applycal.py
# modified: pipeline/hsd/cli/hsd_baseline.py
# modified: pipeline/hsd/cli/hsd_importdata.py
# modified: pipeline/hsd/cli/hsd_skycal.py
#
# Untracked files:
# unit-results.xml
#
