diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000000000000000000000000000000000..a83c2f352a0336414336e4ddca557a7c05bbf5db --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/source/conf.py b/docs/source/conf.py index 19c4416d06d25522be0567a6fae831b378c702dd..06b6cac9a24b4877b50912e5c8cebf647376a555 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -89,7 +89,7 @@ html_favicon = 'favicon.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. diff --git a/docs/source/target.rst b/docs/source/target.rst index 7aae2a6bc5370a8c7d9547a00aa53eeac7be6edb..f6b178061e8c7e76c040ad89f67ada77281506d0 100644 --- a/docs/source/target.rst +++ b/docs/source/target.rst @@ -79,11 +79,7 @@ The workflow ``gsmcal`` consists of: - concatenating the data into chunks (subworkflow ``concat``) - wide-band statistical flagging (steps ``ms_concat`` and ``aoflag``) - checking for bad data chunks (step ``check_unflagged_fraction``) -<<<<<<< HEAD - perform the calibration against the global skymodel (subworkflow ``calibrate_target``, baseline-dependend smoothing (step ``BLsmooth``) if specified ``do_smooth : true``) -======= - - perform the calibration against the global skymodel (subworkflow ``calibrate_target``, baseline-dependend smoothing (step ``BLsmooth``) if specified ``do_smooth : true``)) ->>>>>>> 4f7b5d13b606fd62dd09b652430e5bb7f5f83279 - perform self-calibration against a skymodel derived from imaging the dataset (subworkflow ``selfcal_target_lba`` for **LBA** observations and ``selfcal_target_hba`` (optional) for **HBA** observations) Self-calibration workflow for **HBA** observations (``selfcal_target_hba``)