Compile to HTML: Important Changes
Explore how to document Python code efficiently using Sphinx by setting up conf.py to locate source files, organizing documentation with automodule directives, and structuring index.rst. Understand how to include classes, functions, and warnings in your documentation to maintain clear, professional project docs.
We'll cover the following...
We'll cover the following...
Changes in conf.py
The index.rst is the main file, the top-level file in the hierarchy. We will add to it shortly. First, we need to point Sphinx to the actual source code directory. In source/conf.py, uncomment the three lines in the Path setup section and change the single-dot to two consecutive double-dots, that is, ...