Skip to content

chore(docs): configure stdlib intersphinx#157

Open
jaelliot wants to merge 1 commit into
ioflo:mainfrom
jaelliot:chore/hio-local-sphinx-diagnostics
Open

chore(docs): configure stdlib intersphinx#157
jaelliot wants to merge 1 commit into
ioflo:mainfrom
jaelliot:chore/hio-local-sphinx-diagnostics

Conversation

@jaelliot
Copy link
Copy Markdown
Contributor

Summary

  • Enable sphinx.ext.intersphinx for HIO docs.
  • Add Python stdlib intersphinx mapping.
  • Ignore local Sphinx Doctor/docs artifacts.

Why

Sphinx was reporting unresolved Python stdlib references such as socket.socket, io.IOBase, io.BytesIO, and ssl.SSLContext. Adding stdlib intersphinx resolves those without editing HIO source docstrings.

Validation

  • Rebuilt HIO Sphinx inventory with --docs-dir docs/source.
  • Stable repo root verified for libs/hio.
  • Regenerated Sphinx Doctor diagnostics.
  • Stdlib targets dropped to zero:
    • socket.socket
    • io.IOBase
    • io.BytesIO
    • ssl.SSLContext
  • HIO enriched diagnostics changed from:
    • total: 249 → 230
    • publishable: 34 → 28
    • missing-reference: 233 → 213
  • No HIO source docstrings were edited.
  • Generated artifacts remain ignored.

Note on pre-push hook

The local pre-push pytest gate was bypassed with SKIP_PYTEST=1 after review because the hook failed on an unrelated environment-specific test:

tests/base/test_filing.py::test_filing

The branch diff does not touch that test or its implementation. The failure involved expected /usr/local/var/hio/test vs actual ~/.hio/test, which appears host/environment-specific and unrelated to this docs-config change.

Copilot AI review requested due to automatic review settings May 10, 2026 04:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Enables Sphinx intersphinx support in the HIO documentation build so references to Python standard library types (e.g., socket.socket, io.IOBase) resolve without modifying HIO docstrings.

Changes:

  • Enable sphinx.ext.intersphinx in the Sphinx extensions list.
  • Add a Python stdlib intersphinx mapping to docs/source/conf.py.
  • Ignore local Sphinx diagnostics output and a docs virtualenv directory in .gitignore.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/source/conf.py Adds sphinx.ext.intersphinx and configures stdlib intersphinx mapping.
.gitignore Ignores .sphinx-diagnostics/ and .venv-docs/ artifacts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/source/conf.py
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'test.md']

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
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