Skip to content

Refactor "Customise the setup" #8

@a-velasco

Description

@a-velasco

Background

The Customise the setup 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 (#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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions