← Back to issue list

docs: fix the title in the toc

View original Github issue

Metadata

Project
charmcraft
Number
#2736
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Merged #2736 as commit 3e6cd690, removing obsolete html_title from the docs TOC so the default theme can process the title correctly.

Resolution: closed resolved

Reason: PR #2736 merged with commit 3e6cd690 after approval, fixing the TOC title by removing the obsolete html_title directive.

Evaluated by: mr-cal-bot

No scores available.

Issue body

We don't use `html_title` anymore, bceause it interferes with the default theme processing. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [ ] I've added or updated any relevant documentation. - [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged #2736 as commit 3e6cd690, removing obsolete html_title from the docs TOC so the default theme can process the title correctly.
stealth/space-bunny-alpha — closed resolved Merged PR #2736 removed the obsolete html_title from the documentation TOC, preventing interference with default theme title processing.
qwen/qwen3.6-35b-a3b — — Merged after two approvals. Removed the html_title configuration to fix the table of contents title and prevent conflicts with default theme processing. All required checks passed prior to merge.
qwen3.6-35b-a3b-mtp-q6 — — Merged a documentation update that removed the deprecated html_title configuration, resolving table of contents title rendering conflicts with the default theme processing.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#399 docs: fix title markup craft-parts merged Merged #399 as commit 8b705ede, correcting a one-line documentation title markup issue after two approvals.
78%
#590 docs: remove `html_title` from config starbase merged Merged #590 via commit 9c0cd87, removing the html_title setting so documentation again uses the default “<project> <release> documentation” title.
75%
#588 docs: fix version in title starbase merged Merged docs fix (commit 23328cd): docs page titles now display major.minor version for local, PR and branch builds; only the 'latest' branch shows 'dev', following the RTD version slug simplification.
72%
#1055 docs: fix canonical URL rockcraft merged Merged #1055 in commit 52ef86e3, updating docs to use RTD’s versioned canonical URL and exclude generated pages from the sitemap.
72%
#5441 docs: revise home page snapcraft merged Merged in #5441 via commit 881b9e464, revising the documentation homepage after rebasing onto the reorganized table of contents.
71%
#19 docs: update toc and incorrect labels craft-store merged Merged PR #19 corrected the documentation table of contents and labels across two files (+4/−1 lines).
71%
#2831 docs: fix version string for 3.x charmcraft merged Merged #2831 to display the 3.x major/minor version in docs titles; the latest branch remains labeled dev after Read the Docs slug simplification.
71%
#6387 docs: fix version on 'latest' snapcraft merged Merged PR #6387 via commit a67bdcd1f, fixing docs titles to show major.minor for local, PR, and branch builds while displaying dev for latest.
70%