Conversation
Co-authored-by: cclauss <3709715+cclauss@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix Sphinx docs generation process
Fix Sphinx homepage toctree rendering in Sep 13, 2026
index.md
Contributor
|
Nice catch on the root cause 👍 I reproduced this locally to confirm, and the diagnosis is exactly right:
One small follow-up while you're in here: with the directive now active, the HTML comment line inside the toctree body is treated as a doc reference and produces a warning: Directive bodies aren't Markdown, so the <!-- CONTRIBUTING.md must be the FIRST doc; README.md can come after. -->
```{toctree}
:maxdepth: 2
:caption: index.md
CONTRIBUTING.md
README.md
LICENSE.md |
Member
|
In pre-commit: https://rumdl.dev/md040 and https://rumdl.dev/md073 So we have to modify: Lines 235 to 244 in be65e47 to add... per-file-ignores."index.md" = [ "MD040" ] |
github-actions
Bot
force-pushed
the
copilot/fix-sphinx-docs
branch
from
September 13, 2026 13:15
7168490 to
b5e4908
Compare
cclauss
marked this pull request as ready for review
September 13, 2026 13:20
cclauss
approved these changes
Sep 13, 2026
cclauss
left a comment
Member
There was a problem hiding this comment.
Nice teamwork! Given enough eyeballs, all bugs are shallow.
Member
|
Zero files changed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your change
Sphinx docs were building, but the homepage content was effectively unusable because the root
toctreeinindex.mdwas parsed as a code block instead of a directive. This PR corrects the MyST directive syntax so the homepage renders navigable docs content.index.mdused an invalid fenced directive form:```text {toctree}```{toctree}.github/workflows/sphinx.yml-```text {toctree} +```{toctree} :maxdepth: 2 :caption: index.mdChecklist