Documentation - CodeRefinery May 2021
Channel: CodeRefinery
Date: 20/05/2021

In this lesson we discuss different solutions for implementing and deploying code documentation. We start by creating a wishlist for how we would code documentation like to be. Then after a tour of available tools, we discuss how to write useful and accessible READMEs, and then we progress by demonstrating and practicing the Sphinx documentation generator and demonstrate how to deploy documentation to Read the Docs service.

Topics and tools discussed: Markdown, reStructured text, README documentation, table of contents generation, Sphinx, Read the Docs, GitHub/GitLab pages.

https://coderefinery.github.io/documentation/


00:05 Intro
01:05 Motivation
14:25 Popular tools
21:25 Readme files
24:00 Exercise: Readme files
42:40 Sphinx documentation
46:20 Sphinx type-along
1:08:30 Sphinx exercise
1:10:05 Sphinx exercise demo
1:24:25 What comes next
1:26:40 ReadTheDocs summary
1:28:30 Github Pages summary
1:30:20 Summary, eend of day
1:32:40 ReadTheDocs demo


This is part of the CodeRefinery May 2021 workshop.  The videos are available to everyone, but may be most useful to the people who attended the workshop and want to review later.

Playlist: https://www.youtube.com/playlist?list=PLpLblYHCzJACm0Nz8ZxmdC6F8UuSYwWGQ
Workshop webpage: https://coderefinery.github.io/2021-05-10-workshop/
CodeRefinery: https://coderefinery.org/