diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..bfd7b7c --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/src/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/control/export_region.proto b/control/export_region.proto index af9ffc3..d724116 100644 --- a/control/export_region.proto +++ b/control/export_region.proto @@ -21,6 +21,8 @@ message ExportRegion { string directory = 5; // Optional file name of server file string file = 6; + // Optional overwrite existing file + bool overwrite = 7; } // EXPORT_REGION_ACK @@ -32,4 +34,6 @@ message ExportRegionAck { string message = 2; // File contents for client export (one line per string) repeated string contents = 3; + // Request for overwrite confirmation + bool overwrite_confirmation_required = 4; } diff --git a/docs/requirements.txt b/docs/requirements.txt index 5c247ef..db02125 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -Sphinx==4.1.2 +Sphinx==7.3.7 plantweb==1.2.1 -sphinxcontrib-svg2pdfconverter==1.1.1 -sphinx-rtd-theme==0.5.2 +sphinxcontrib-svg2pdfconverter==1.2.2 +sphinx-rtd-theme==2.0.0 diff --git a/docs/src/changelog.rst.txt b/docs/src/changelog.rst.txt index 031fac8..bd7f333 100644 --- a/docs/src/changelog.rst.txt +++ b/docs/src/changelog.rst.txt @@ -220,6 +220,12 @@ Changelog - 27/10/23 - Adjusted file ID generation. * - ``28.15.0`` + - 23/05/24 + - Added :carta:ref:`RemoteFileRequest` and :carta:ref:`RemoteFileResponse` messages. + * - ``29.0.0`` + - 26/06/24 + - Added ``overwrite`` to :carta:ref:`SaveFile` and :carta:ref:`ExportRegion` messages. + * - ``29.1.0`` - 23/07/24 - Added ``rest_freq`` to :carta:ref:`MomentRequest` message. diff --git a/docs/src/enums.rst.txt b/docs/src/enums.rst.txt index d23d6e6..cd066bf 100644 --- a/docs/src/enums.rst.txt +++ b/docs/src/enums.rst.txt @@ -540,6 +540,12 @@ Source file: `shared/enums.proto `_ + + + +.. list-table:: + :widths: 20 20 20 40 + :header-rows: 1 + :class: proto + + * - Field + - Type + - Label + - Description + * - file_id + - sfixed32 + - + - File ID + * - hips + - string + - + - ID or keyword identifying the HiPS to use + * - wcs + - string + - + - The WCS definition of the cutout, defined as a key-value dictionary JSON string + * - width + - int32 + - + - Width in pixels of the output image + * - height + - int32 + - + - Height in pixels of the output image + * - projection + - string + - + - Name of the requested projection, eg: SIN, TAN, MOL, AIT, CAR, CEA, STG + * - fov + - float + - + - Size (FoV) of the cutout on the sky, in decimal degrees + * - ra + - float + - + - Right ascension in decimal degrees of the center of the output image + * - dec + - float + - + - Declination in decimal degrees of the center of the output image + * - coordsys + - string + - + - coordsys Coordinate frame system to be used for the projection + * - rotation_angle + - float + - + - Angle value (in decimal degrees) to be applied to the projection + * - object + - string + - + - Name of the object the output image will be centered on. The name will be resolved to coordinated by the Sesame service. + +.. carta:class:: carta-b2f remotefileresponse + +.. _remotefileresponse: + +RemoteFileResponse +~~~~~~~~~~~~~~~~~~ + +Source file: `request/remote_file_request.proto `_ + + + +.. list-table:: + :widths: 20 20 20 40 + :header-rows: 1 + :class: proto + + * - Field + - Type + - Label + - Description + * - success + - bool + - + - Defines whether the remote file was opened successfully + * - message + - string + - + - Error message (if applicable) + * - open_file_ack + - :carta:refc:`OpenFileAck` + - + - Opened file information + .. carta:class:: carta-f2b removeregion .. _removeregion: @@ -2258,6 +2368,10 @@ Source file: `request/save_file.proto