Skip to content

docs: describe extension support#16

Merged
medubelko merged 5 commits into
canonical:mainfrom
shaloo:shaloo/fix-docpr-1799
Jul 22, 2026
Merged

docs: describe extension support#16
medubelko merged 5 commits into
canonical:mainfrom
shaloo:shaloo/fix-docpr-1799

Conversation

@shaloo

@shaloo shaloo commented Jun 19, 2026

Copy link
Copy Markdown
Contributor
  • Have you updated CHANGELOG.md with relevant non-documentation file changes?
  • Have you updated the documentation for this change?

@shaloo
shaloo force-pushed the shaloo/fix-docpr-1799 branch from 1635ea2 to 012ee3e Compare June 19, 2026 16:29
@shaloo
shaloo marked this pull request as draft June 19, 2026 16:34
@shaloo
shaloo force-pushed the shaloo/fix-docpr-1799 branch 3 times, most recently from 373a90d to 047dd74 Compare June 19, 2026 16:43
@jahn-junior

Copy link
Copy Markdown
Collaborator

The spell check failure is caused by a bug that came about when we incorporated sphinx-llm. I'm bringing in the patch fix from the sphinx-stack repo with #17.

@shaloo
shaloo marked this pull request as ready for review June 26, 2026 09:54
@shaloo
shaloo marked this pull request as draft June 26, 2026 09:54
@shaloo
shaloo marked this pull request as ready for review July 1, 2026 08:59
@shaloo
shaloo marked this pull request as draft July 1, 2026 08:59
@shaloo

shaloo commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

@jahn-junior would you know by when you'll be able to bring in the patch fix here for the spell check failure resolution?

@SecondSkoll

Copy link
Copy Markdown
Collaborator

If you rebase this now @shaloo it should pass.

@shaloo
shaloo marked this pull request as ready for review July 3, 2026 17:03
@shaloo
shaloo marked this pull request as draft July 3, 2026 17:10
@shaloo
shaloo marked this pull request as ready for review July 6, 2026 16:42

@a-velasco a-velasco left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the bonus whitespace cleanup :)

Comment thread docs/how-to/configure-your-project.rst Outdated

@jahn-junior jahn-junior left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The added text doesn't quite reflect our supported extensions. We do support all of the extensions listed in the Sphinx Stack requirements.txt file. Because canonical-sphinx is included in this file, we do also support the extensions it sets up.

However, we do not recommend using the optional full dependency group, and this change could be interpreted as though we do. So, I think for simplicity's sake, we should just say that we only fully support the extensions listed in the default requirements.txt file. Since canonical-sphinx is getting deprecated soon, this is also more future-proof.

Co-authored-by: Andreia <andreia.velasco@canonical.com>
@shaloo
shaloo requested review from a-velasco and jahn-junior July 15, 2026 09:47
Comment thread docs/how-to/update-sphinx-stack/legacy-sphinx-stack.rst Outdated
Comment thread docs/how-to/configure-your-project.rst Outdated
Co-authored-by: JJ Coldiron <jj.coldiron@canonical.com>
@shaloo
shaloo requested a review from jahn-junior July 21, 2026 03:47
@medubelko medubelko changed the title DOCPR-1799 fix for adding support limitation docs: describe extension support Jul 22, 2026
@medubelko
medubelko merged commit d4572b2 into canonical:main Jul 22, 2026
9 checks passed
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.

5 participants