Code documentation lesson
In this lesson we will discuss different solutions for implementing and
deploying code documentation.
We will learn how to build documentation with the
documentation generator Sphinx (and compare it
with others) and how to
deploy it to Read the Docs, a service which hosts
open documentation for free.
This demonstration will be independent of programming languages.
We will also learn how
to deploy a project website or personal homepage to GitHub Pages.
The approach that we will learn will be transferable to
GitLab Pages and
Basic understanding of Git.
You need to have Sphinx installed (as
part of your Python environment installation).
For the GitHub Pages part you need a GitHub account.