How to document your research software
The lesson
Motivation and wishlist
Popular tools and solutions
In-code documentation
Writing good README files
Sphinx and Markdown
Deploying Sphinx documentation to GitHub Pages
Hosting websites/homepages on GitHub Pages
Summary
Reference
List of exercises
Instructor guide
Credit and license
About
All lessons
CodeRefinery
Reusing
How to document your research software
Index
Edit on GitHub
Index