From d81b503671c888f4f9bfd410ad634d491d7ef718 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nikolaj=20S=C3=B8rensen?= Date: Sat, 30 Mar 2024 14:54:58 +0100 Subject: [PATCH 1/3] Update error codes in image-processing-pipeline.md --- doc/disco-2/software/image-processing-pipeline.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/disco-2/software/image-processing-pipeline.md b/doc/disco-2/software/image-processing-pipeline.md index f6ac158..8110cf3 100644 --- a/doc/disco-2/software/image-processing-pipeline.md +++ b/doc/disco-2/software/image-processing-pipeline.md @@ -216,6 +216,10 @@ DIPP includes an integer parameter indicating the most recent cause of failure. | 504 | Internal Error: Integer Parameter Not Found | | 505 | Internal Error: Float Parameter Not Found | | 506 | Internal Error: String Parameter Not Found | +| 507 | Internal Error: Failed to pull remote parameter | +| 508 | Internal Error: Failed to push remote parameter | +| 509 | Internal Error: VMEM Not Found | +| 510 | Internal Error: VMEM Upload Failed | | 600 | Module Exit Error: Crash | | 601 | Module Exit Error: Normal | | 700-799 | Module Exit Error: Custom error code defined by module | From 18b74d4e48b68ce1ea5ba466d63dca7fc5692cc4 Mon Sep 17 00:00:00 2001 From: NValsted Date: Tue, 9 Apr 2024 02:49:52 +0200 Subject: [PATCH 2/3] Embed csp_proc documentation --- .gitmodules | 3 +++ doc/disco-2/software/flight-planning-csp-proc.rst | 12 ++++++++++++ doc/disco-2/software/index.rst | 1 + doc/disco-2/sub-docs/csp_proc | 1 + doc/disco-2/sub-docs/csp_proc_function_reference.rst | 7 +++++++ 5 files changed, 24 insertions(+) create mode 100644 .gitmodules create mode 100644 doc/disco-2/software/flight-planning-csp-proc.rst create mode 160000 doc/disco-2/sub-docs/csp_proc create mode 100644 doc/disco-2/sub-docs/csp_proc_function_reference.rst diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..6fb7928 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "doc/disco-2/sub-docs/csp_proc"] + path = doc/disco-2/sub-docs/csp_proc + url = https://github.com/discosat/csp_proc.git diff --git a/doc/disco-2/software/flight-planning-csp-proc.rst b/doc/disco-2/software/flight-planning-csp-proc.rst new file mode 100644 index 0000000..8166bbb --- /dev/null +++ b/doc/disco-2/software/flight-planning-csp-proc.rst @@ -0,0 +1,12 @@ +Flight planning (csp_proc) +====================== + + +`csp_proc` is the library responsible for low-level flight planning / orchestration of the CSP nodes for scientific observations. It provides a set of general instructions that can be used to set libparam parameters with simple synchronization and conditional logic. The library is described in more detail on its own documentation page at https://discosat.github.io/csp_proc/ - which is also embedded as the following sub-pages. + +.. toctree:: + :maxdepth: 2 + + ../sub-docs/csp_proc/index + ../sub-docs/csp_proc_function_reference.rst + \ No newline at end of file diff --git a/doc/disco-2/software/index.rst b/doc/disco-2/software/index.rst index cf61cf2..ca730e7 100644 --- a/doc/disco-2/software/index.rst +++ b/doc/disco-2/software/index.rst @@ -5,3 +5,4 @@ Software .. toctree:: getting-started.md image-processing-pipeline.md + flight-planning-csp-proc.rst diff --git a/doc/disco-2/sub-docs/csp_proc b/doc/disco-2/sub-docs/csp_proc new file mode 160000 index 0000000..2208654 --- /dev/null +++ b/doc/disco-2/sub-docs/csp_proc @@ -0,0 +1 @@ +Subproject commit 22086542196e510f4e1f1f741168eb7981724e88 diff --git a/doc/disco-2/sub-docs/csp_proc_function_reference.rst b/doc/disco-2/sub-docs/csp_proc_function_reference.rst new file mode 100644 index 0000000..c960d64 --- /dev/null +++ b/doc/disco-2/sub-docs/csp_proc_function_reference.rst @@ -0,0 +1,7 @@ +`csp_proc` Function Reference +====================== + + +.. raw:: html + + From d9c98cd0f3c95f962fca32c764ef21af678438b0 Mon Sep 17 00:00:00 2001 From: NValsted Date: Tue, 9 Apr 2024 02:57:33 +0200 Subject: [PATCH 3/3] CI/CD: update doc build action to pull submodules --- .github/workflows/documentation.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index f98f6ba..241e1c7 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -9,7 +9,10 @@ jobs: docs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - name: Checkout code (including submodules) + uses: actions/checkout@v3 + with: + submodules: recursive - uses: actions/setup-python@v3 - name: Install dependencies run: |