Fix ReadTheDocs build: Import README.md and enable CLI documentation generation#67
Merged
Fix ReadTheDocs build: Import README.md and enable CLI documentation generation#67
Conversation
Co-authored-by: akhanf <11492701+akhanf@users.noreply.github.com>
Co-authored-by: akhanf <11492701+akhanf@users.noreply.github.com>
Co-authored-by: akhanf <11492701+akhanf@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation to use README.md as title page
Fix ReadTheDocs build: Import README.md and enable CLI documentation generation
Feb 2, 2026
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.
ReadTheDocs was configured to include
README.rst(doesn't exist) and CLI documentation failed to generate due to__file__being undefined in Sphinx import context.Changes
Markdown Support
myst-parserextension todocs/conf.pyanddocs/requirements.txtdocs/index.rstto includeREADME.mdinstead ofREADME.rstAPI Documentation Fix
Fixed
snakedwi/run.pyto handle Sphinx import where__file__is undefined:Configuration
.readthedocs.ymlwith Python 3.12 and proper build settingssnakebidsversion in docs requirements from==0.2.1to>=0.14.0,<0.15docs/_build/to.gitignoreResult
Documentation now builds successfully with README content on index page and full CLI argument documentation.
Index page with README.md:

CLI API documentation:

Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.