Skip to content

Align Sphinx docs root with GitHub Pages artifact root (no repo-root docs file required)#78

Merged
beykyle merged 1 commit into
mainfrom
copilot/fix-documentation-404-error
May 19, 2026
Merged

Align Sphinx docs root with GitHub Pages artifact root (no repo-root docs file required)#78
beykyle merged 1 commit into
mainfrom
copilot/fix-documentation-404-error

Conversation

Copilot AI commented May 19, 2026

Copy link
Copy Markdown
Contributor

GitHub Pages was deploying successfully but serving a 404 at the site root because the built docs entry page was nested (docs/index.html) instead of artifact-root index.html. The change keeps documentation scoped to the docs folder while ensuring Pages resolves / correctly.

  • Root doc alignment

    • Updated Sphinx root doc configuration so the generated entry page is index.html at the deploy artifact root (the folder uploaded to Pages), rather than a nested docs path.
  • Docs source/layout consistency

    • Kept documentation content under docs/ and adjusted docs entry wiring so docs remain organized in the docs tree without requiring a committed static index.html at repository root.
  • Duplicate root prevention

    • Excluded the alternate docs index path from Sphinx input to avoid multiple competing root documents in the build graph.
# docs/conf.py
root_doc = "index"
exclude_patterns = [
    # ...
    "docs/index.md",
]

@beykyle beykyle marked this pull request as ready for review May 19, 2026 02:09
@beykyle beykyle merged commit 6e328f4 into main May 19, 2026
7 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.

2 participants