Skip to content

Draft: Add Satellite Documentation

Simon Spannagel requested to merge p-docs-satellites into main

This is working towards documentation of individual satellites, the collection thereof and publication on the website

What this needs to do still:

  • Glob all README.md from cxx and py satellites
  • Copy them into the docs/satellites folder, changing the same to sth like cxx_satllites_prorotype.md
  • Amend their file name in the toctree list of docs/satellites/index.md

Optional things include:

  • Make some nice rendering out of the header block by defining a sphinx template for it
  • Define the standardized fields we want in there

This closes #81

Edited by Simon Spannagel

Merge request reports