fix(docs): display examples correctly in RTD
Metadata
Current evaluation
Merged a fix correcting auto-generated documentation rendering on ReadTheDocs. The change resolved command example display issues, received two approvals, passed CI checks, and was successfully integrated.
Suggested action: —
No scores available.
Issue body
- [ ] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `tox run -m lint`?
- [ ] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`)
Some of the commands auto-generated docs were not rendered correctly, this PR addresses that
Before:
After:
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged a fix correcting auto-generated documentation rendering on ReadTheDocs. The change resolved command example display issues, received two approvals, passed CI checks, and was successfully integrated. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged to fix auto-generated documentation examples rendering incorrectly on ReadTheDocs. Approved after team discussion on documentation structure and parser enhancements, successfully resolving the display issue. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged to fix auto-generated command examples rendering in ReadTheDocs. Changes were approved following a discussion on documentation structure and parser enhancements, successfully resolving the display issue. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #4258 docs: enable RTD builds | snapcraft | merged | Merged into main after approval and passing CI. The change enabled ReadTheDocs builds by adding documentation configuration to a single file. | |
| #401 ci: make RTD use `make docs` | starbase | merged | Merged after approval by three reviewers and passing CI checks. Updated CI configuration to use make docs for ReadTheDocs builds, modifying two files with seven additions and three deletions. | |
| #383 docs: fail on RTD warnings | starbase | merged | Merged configuration to fail CI builds on ReadTheDocs warnings, resolving a recurring issue where documentation warnings were silently ignored. Approved by two reviewers and passed all checks. | |
| #400 ci: make RTD use `make docs` | starbase | closed | Merged to configure ReadTheDocs to use make docs for documentation builds. All CI checks passed and the change was accepted without review comments. | |
| #586 docs: fix incorrect version in documentation | rockcraft | merged | Merged to resolve #584. Configured ReadTheDocs to fetch tags and updated non-release documentation to display dev instead of misleading release strings. Approved by two reviewers with passing CI. | |
| #5468 docs: fix RTD build | snapcraft | merged | Merged PR fixing the ReadTheDocs build by renaming matter SDK docs to underscores, removing them from the ignore list, and enabling fail-on-warnings. Approved with all CI checks passing. Related ToC warnings deferred. |