Скачать или смотреть 6.1 Documentation - CodeRefinery 2025 Sep

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 Github Pages.

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

https://coderefinery.github.io/docume...

00:00 Introduction to topics, initial questions
01:56 § Motivation and wishlist
22:03 § Popular tools and solutions
29:53 § In-code documentation
34:33 § README files
45:03 Discussion of exercise
50:58 § Sphinx and Markdown
1:17:04 Good to know
1:20:53 § Deploying Sphinx documentation to Github Pages
1:32:43 § Summary and Q&A

-----

This is part of the CodeRefinery 2025 September workshop. The videos are available to everyone, but may be most useful to the people who attended the workshop and want to review later. Day 1-2: git (individual) Day 3: git (collaborative) Day 4: reproducible research and social coding. Day 5: documentation and Jupyter. Day 6: testing and modular code development.

Playlist:    • CodeRefinery workshop 2025 Sep-Oct  

Workshop webpage: https://coderefinery.github.io/2025-0...

CodeRefinery: https://coderefinery.org/