How to document your research software

The lesson

  • In-code documentation
  • Writing good README files
  • Sphinx and Markdown
  • Deploying Sphinx documentation to GitHub Pages
  • Popular tools and solutions
  • Motivation and wishlist
  • Summary

Supplementary material

  • Hosting websites/homepages on GitHub Pages

Reference

  • Shell crash course
  • List of exercises
  • Instructor guide
  • Credit and license

About

  • All lessons
  • CodeRefinery
  • Reusing
How to document your research software
  • Search

© Copyright CodeRefinery contributors.

Built with Sphinx using a theme provided by Read the Docs.