5.2 Documentation - CodeRefinery March 2023
Channel: CodeRefinery
Date: 2023-03-29

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:00 Intro
02:33 § Motivation and wishlist
15:29 § README files
16:57 Exercise: Readme files
18:51 Post-exercise discussion
19:53 Sphinx and Markdown intro
22:13 Sphinx Typealong starts
30:51 Exercise: more Sphinx things
32:10 Post-exercise discussion
33:30 § Deploying Sphinx to GitHub Pages (Demo)
51:53 Tomorrow, questions, summary, and feedback

-----

This is part of the CodeRefinery March 2023 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=PLpLblYHCzJACsZllghoLA4JBMjkTk0eq4

Workshop webpage: https://coderefinery.github.io/2023-03-21-workshop/

CodeRefinery: https://coderefinery.org/