Skip to content
Snippets Groups Projects

RAP-840 Add Read the Docs

Merged RAP-840 Add Read the Docs
All threads resolved!
Merged Mick Veldhuis requested to merge rap-840-add-docs into main
All threads resolved!

This MR adds Read the Docs documentation pages. It includes:

  • Installation instructions
  • Instructions to run the pipeline
  • A basic overview of the operations and adjustable parameters

Given that the pipeline is still very much in development, a lot of this information is subject to change. This is just a first pass at the user documentation.

Edited by Mick Veldhuis

Merge request reports

Pipeline #103023 passed

Pipeline passed for a8720d31 on rap-840-add-docs

Approved by

Merged by Mick VeldhuisMick Veldhuis 1 month ago (Dec 20, 2024 4:16pm UTC)

Merge details

  • Changes merged into main with d448282b (commits were squashed).
  • Deleted the source branch.

Pipeline #103036 passed

Pipeline passed for d448282b on main

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Mick Veldhuis added 1 commit

    added 1 commit

    Compare with previous version

  • Mick Veldhuis added 1 commit

    added 1 commit

    Compare with previous version

  • Mick Veldhuis added 5 commits

    added 5 commits

    • fb099518 - Add missing links
    • 63098a2d - Add readthedocs link to README
    • ca06ffb3 - Add SASID and ignoretarget clarifications
    • 084256fe - Add mention of apptainer and update parameter overview
    • 093b6ab0 - Refer to relevant DP3 readthedocs pages

    Compare with previous version

  • Mick Veldhuis added 1 commit

    added 1 commit

    • cb452a44 - Mention --singularity option

    Compare with previous version

  • Mick Veldhuis added 2 commits

    added 2 commits

    • fb485d38 - Update Docker installation
    • 57a0a13c - Add instructions for running within a container

    Compare with previous version

  • Mick Veldhuis added 1 commit

    added 1 commit

    Compare with previous version

  • Mick Veldhuis added 1 commit

    added 1 commit

    Compare with previous version

  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Marcel Loose
  • Mick Veldhuis added 4 commits

    added 4 commits

    • 8f480814 - Reword affect -> affect averaging
    • 2017bbac - Remove link to installation directions in repo
    • 0eaaf7c9 - Add repo link to docker install section
    • 3bc47863 - Reference the json input

    Compare with previous version

  • Mick Veldhuis added 2 commits

    added 2 commits

    • 2a9c089c - Explicitly mention mounting output/log dirs
    • a8720d31 - Remove Docker installation note

    Compare with previous version

  • Marcel Loose resolved all threads

    resolved all threads

  • Marcel Loose approved this merge request

    approved this merge request

  • merged

  • Mick Veldhuis mentioned in commit d448282b

    mentioned in commit d448282b

  • Please register or sign in to reply
    Loading