[project]

Project configuration settings

Guide: project.

project.description

Type:

string

Default:

""

A description of the project.

project.language

Type:

string

Default:

""

The language the documents are written in, as a language code such as "en", "de" or "pt_BR".

Selects the quote characters [build] smartquotes uses („…“ for "de", «…» for "fr", and so on) and the lang attribute of every HTML page; it affects nothing else yet. For "ja", "zh_CN" and "zh_TW", and for a language without quote characters of its own (which is reported), smartquotes changes nothing, as in Sphinx.

Unset or an empty string means "en".

Equivalent to Sphinx’s language configuration value.

project.name

Type:

string

Default:

""

The name of the project.

project.release

Type:

string

Default:

""

The full project release, e.g. 1.2.3b1.

Substituted for the |release| default substitution reference (unless a document defines its own |release|). Independent of version: unset or an empty string substitutes empty text, with no fallback to version.

project.root_doc

Type:

string

Default:

""

The document at the root of the table-of-contents tree, given as its docname (the source path relative to the source directory, without the file extension). Toctree expansion and the document ordering start here.

Unset or an empty string means "index".

project.srcdir

Type:

string

Default:

""

DEPRECATED — use [source] dir instead, which names the same directory beside the other source roots.

The directory the project’s own documents are discovered from, relative to this file. Unset or an empty string means the directory holding this configuration file.

It keeps working unchanged, with one difference from [source] dir: the discovery globs stay anchored at this file’s own directory instead of being matched under each source root. When both keys are set, [source] dir wins and this one is ignored.

project.today

Type:

string

Default:

""

A fixed date string for the |today| default substitution.

When set, |today| substitutes this text verbatim (reproducible builds). Unset or an empty string formats the current build date with today_fmt.

project.today_fmt

Type:

string

Default:

""

The strftime format for the |today| default substitution when today is unset.

Unset or an empty string uses %b %d, %Y (e.g. Jul 17, 2026).

project.version

Type:

string

Default:

""

The version of the project.

Substituted for the |version| default substitution reference (unless a document defines its own |version|). Unset or an empty string substitutes empty text.