Configure your project

Sphinx Stack documentation projects are configured in the docs/conf.py file. The default configuration will work for most projects, but you still need to set some project-specific values, such as your product’s name and documentation URL.

Important

The Sphinx Stack is updated periodically. After you set up your documentation repository with the Sphinx Stack, you need to track the changes made to the Sphinx Stack and manually maintain your repository.

Use the Sphinx Stack release notes or changelog to track changes to the Sphinx Stack. Subscribe to the repository releases to get notified whenever there is a new release. For the recommended way of manually updating your Sphinx Stack, see Update your Sphinx Stack.

Mandatory configuration values are marked with TODO in the conf.py file. Set these to align with your project and ensure you comment out any settings that aren’t relevant to your environment.

Steps 1 – 5 cover the required configuration. For details, see Required configuration.

1. Set project identity, branding, and repository metadata.

2. Set the documentation site URL.

3. Configure feedback and page navigation behavior.

4. Define LLM metadata.

5. Configure how Sphinx should validate links.

6. Add optional configuration as needed. The following links can help you with additional configuration:

• Sphinx configuration

• Sphinx extensions

• Furo documentation