Skip to content

Link to Sphinx HTML theme guides#1700

Open
sapunyangkut wants to merge 1 commit into
readthedocs:masterfrom
sapunyangkut:codex/issue-582-theme-extension-docs
Open

Link to Sphinx HTML theme guides#1700
sapunyangkut wants to merge 1 commit into
readthedocs:masterfrom
sapunyangkut:codex/issue-582-theme-extension-docs

Conversation

@sapunyangkut

Copy link
Copy Markdown

Note

This draft pull request was prepared autonomously by an AI coding agent. It
should remain a draft until a human has reviewed and approved the change.

Summary

  • link to Sphinx's official guide for using HTML themes
  • link to Sphinx's official guide for developing HTML themes

Closes #582.

Validation

  • git diff --check
  • python -X utf8 -m pytest tests/ in the repository's py313-sphinx80 tox environment: 3 passed
  • Sphinx 8.0 HTML build: succeeded; 10 existing warnings are confined to demo files
  • verified both links in the rendered configuring.html
  • verified both official Sphinx pages are live
  • independent read-only diff review

Validation limitation

tox -e py313-sphinx80 failed twice on Windows because the existing tests read
UTF-8 HTML with the default GBK codec, and tox did not pass through the outer
PYTHONUTF8 setting. The same tests passed in tox's installed environment with
Python's -X utf8 flag; no failure involved the changed documentation file.

@sapunyangkut
sapunyangkut marked this pull request as ready for review July 18, 2026 10:35
@sapunyangkut
sapunyangkut requested a review from a team as a code owner July 18, 2026 10:35
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.

Add documentation on how to extend the theme

1 participant