RAP-840 Add Read the Docs
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.
Merge request reports
Activity
assigned to @veldhuis
The
readthedocs
pages corresponding to this branch are available at: https://lofar-pre-processing-pipeline.readthedocs.io/en/rap-840-add-docs/.I didn't realise that when creating the
readthedocs
project over at https://app.readthedocs.org the name of the project would also be the URL. Therefore, the URL is rather bulky right now. Maybe we'd want to change this?Edited by Mick Veldhuisrequested review from @loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Marcel Loose
- Resolved by Mick Veldhuis
I couldn't find the actual readthedocs page. Maybe good to add a reference to it in the documentation.
Edited by Marcel Loose
added 2 commits
- Resolved by Mick Veldhuis
- Resolved by Marcel Loose
- Resolved by Mick Veldhuis
- Resolved by Mick Veldhuis
- Resolved by Mick Veldhuis
- Resolved by Mick Veldhuis
I added a few remarks, but I think you should also request from the commissioners. Not now, but I can imagine a follow-up issue like "improve documentation".
added 2 commits
mentioned in commit d448282b