Under the hood

Your site’s stack

This site uses the static site generator and documentation site builder sphinx and it is called by a GitHub action to build. You edit markdown, it converts to HTML and hosts.

Sphinx can also automatically generate documentation website from example code for a library and the underlying documentation in the package. It is focused on python but has other language support. A popular way to do this in Python is with autodoc, other languages have other exensions, for example matlabdomain adds MATLAB support.

For the workshop

The shorturls eg drsmb.co/nsbe50 are hosted in a repo, drsmb-co.github.io that is linked to my custom domain drsmb.co. It builds from a yaml file to the html site using a package urlfwd that I made, called by a GitHub action, similar to the one that builds your site.