From 92b374a553b4758b05718d0e2b57c55ef76860b9 Mon Sep 17 00:00:00 2001 From: Karim Ahmed <karim.ahmed@xfel.eu> Date: Mon, 15 May 2023 14:27:31 +0200 Subject: [PATCH] small refactors --- docs/gen_ref_pages.py | 8 +++----- docs/operation/available_notebooks.md | 4 ++-- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/gen_ref_pages.py b/docs/gen_ref_pages.py index 289388880..af1a47724 100644 --- a/docs/gen_ref_pages.py +++ b/docs/gen_ref_pages.py @@ -32,11 +32,9 @@ for directory in ["src"]: identifier = ".".join(parts) if "calcat_interface" == full_doc_path.stem: - print( # adding an note and image for calcat_interface.py - """ - ??? Note "This module help in skipping calibrationDBRemote" -  - """, + # adding an note and image for calcat_interface.py + print("""??? Note "This module help in skipping calibrationDBRemote"\n\t[Calibration DB Remote avoided](xfel-calibrate_cli_process_no_caldbremote.png) + """, file=fd) print("::: " + "src." + identifier, file=fd) diff --git a/docs/operation/available_notebooks.md b/docs/operation/available_notebooks.md index 8251b83cc..4b517c510 100644 --- a/docs/operation/available_notebooks.md +++ b/docs/operation/available_notebooks.md @@ -277,7 +277,7 @@ The following notebook provides gain characterization for the pnCCD. It relies o ??? warning "No description" - TODO: Add description for this notebook + TODO: Add description for this notebook --------------------------------------------------------------------------------------- @@ -303,7 +303,7 @@ Dark characterization evaluates offset and noise of the detector and gives infor ??? warning "Detector notebooks are outdated." - FastCCD notebooks are outdated as the detector hasn't been used for years. + FastCCD notebooks are outdated as the detector hasn't been used for years. ### [FastCCD Data Correction](https://git.xfel.eu/calibration/pycalibration/-/blob/master/notebooks/FastCCD/CorrectionNotebook_NewDAQ_FastCCD_NBC.ipynb) -- GitLab