Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Embed csp_proc documentation #5

Merged
merged 1 commit into from
Apr 9, 2024
Merged

Embed csp_proc documentation #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions doc/disco-2/software/flight-planning-csp-proc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

1 change: 1 addition & 0 deletions doc/disco-2/software/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ Software
.. toctree::
getting-started.md
image-processing-pipeline.md
flight-planning-csp-proc.rst
1 change: 1 addition & 0 deletions doc/disco-2/sub-docs/csp_proc
Open in desktop
Submodule csp_proc added at 220865
7 changes: 7 additions & 0 deletions doc/disco-2/sub-docs/csp_proc_function_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
`csp_proc` Function Reference
======================


.. raw:: html

<meta http-equiv="refresh" content="0; url=https://discosat.github.io/csp_proc/docs/html/index.html" />
Loading