Published August 3, 2026
| Version 2026-08-03
Lesson
Open
How to document your research software - CodeRefinery lesson
Description
The lesson 'How to document your research software' gives an overview of the different ways how a code project can be documented: from small projects to larger projects. Markdown and Sphinx are central tools in this lesson.
Source code: https://github.com/coderefinery/documentation
Lesson website: https://coderefinery.github.io/documentation/
CodeRefinery website: https://coderefinery.org
Files
coderefinery-documentation-2026-08-03.pdf
Files
(1.0 MB)
| Name | Size | Download all |
|---|---|---|
|
md5:822cfac15f30f458f29f67085baf5924
|
978.1 kB | Preview Download |
|
md5:3804898d532e031c3451e5512941d4d4
|
49.1 kB | Preview Download |