canonical / canonical/sphinx-stack-docs

Refactor "Customise the setup"

Open
#8 0 comments 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

The [Customise the setup](https://canonical-starter-pack.readthedocs-hosted.com/stable/how-to/customise/) how-to guide is currently a mix of mandatory steps and reference information.

## Request

Update this page to be a concise guide about what `config.py` parameters to change. Begin with "mandatory" parameters (e.g. name of the project), and continue with the minimal recommendations/best practices for a simple setup.

**It is not necessary to cover everything in the `conf.py`**. Detailed information about all the parameters will be part of a new reference page (https://github.com/canonical/sphinx-stack-docs/issues/6)

Consider renaming this page to "Configure the setup" or "Configure the documentation. I suggest using "configuration" to refer to the general act of tuning the `conf.py` file, and "customisation" in more specific and advanced contexts, like adding custom HTML templates or snippets of code.

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.