canonical / canonical/sphinx-stack-docs

Create a comprehensive `conf.py` reference

Open
#6 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
No language data
Stars
4
Forks
11
Avg merge
13d 16h
Merged PRs (30d)
2

Description

# 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.