Background
Currently, the conf.py values used by the Starter Pack are only documented through code comments. These comments don't comprise a complete reference and clutter up the conf.py file itself.
The comments in conf.py provide versioned, important details about the file. However, they should be limited to the essential details of each value. We should not be providing explanatory information or using them in place of proper documentation.
Request
- Document each of the configuration values used by the Starter Pack
- Remove non-essential comments from the
conf.py file and instead link to the aforementioned page
Background
Currently, the
conf.pyvalues used by the Starter Pack are only documented through code comments. These comments don't comprise a complete reference and clutter up theconf.pyfile itself.The comments in
conf.pyprovide versioned, important details about the file. However, they should be limited to the essential details of each value. We should not be providing explanatory information or using them in place of proper documentation.Request
conf.pyfile and instead link to the aforementioned page