Compile to HTML: Make HTML

Learn how to make HTML pages from .rst files.

Building the documentation

Building the documentation is an automated process. The autodoc extension will first construct .rst files. These are then converted into HTML pages. On Linux and Mac, this is accomplished using make, an oldie-but-goodie command-line tool for automating a series of steps according to a Makefile. Created in 1976, it is still widely used.

make html

Notice how the section, warning, class, and methods are documented. Note that you can put directives and mark-ups in all of those docstrings as well.

Get hands-on with 1200+ tech skills courses.