Skip to content

Add canary page for verifying default extensions#1

Closed
a-velasco wants to merge 10 commits into
mainfrom
canary-page
Closed

Add canary page for verifying default extensions#1
a-velasco wants to merge 10 commits into
mainfrom
canary-page

Conversation

@a-velasco

@a-velasco a-velasco commented Jul 7, 2026

Copy link
Copy Markdown
Owner

Added a page listing all default Sphinx extensions and, where possible, rendering an example output to verify the extension acts as expected.

See rendered version at https://canonical-sphinx-stack-testing.readthedocs-hosted.com/canary/canary-page/

@a-velasco a-velasco left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left comments in locations where I could particularly use some feedback.

Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated

@medubelko medubelko left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good!

I'm seeing a bit of a mix between checks that require eyeballs (look for an element on the page) and raw HTML and links that could be checked. For agents, the former case an agent would need extra tooling and tokens to read.

What do you think about going back to the ones with soft descriptions, and pasting sample HTML to look for?

Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated
Comment thread docs/canary-page.md Outdated
@a-velasco

Copy link
Copy Markdown
Owner Author

Replaced by canonical/sphinx-stack#618

@a-velasco a-velasco closed this Jul 17, 2026
medubelko added a commit to canonical/sphinx-stack that referenced this pull request Jul 18, 2026
Port of changes from
a-velasco/sphinx-stack-testing#1 to the
DOCPR-2690 feature branch of the sphinx-stack repository. This makes it
easier to keep in sync with the Stack and test behaviour that relies on
the final RTD URL.

This PR contains changes made after @medubelko's first review. All
suggestions were applied.

This PR adds a page with simple tests for every default extension in the
Stack that could potentially break.

---------

Co-authored-by: Michael DuBelko <michael.dubelko@canonical.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants