Closed
Conversation
…n the automatically generated documentation and to make it available for coding agents. Add myst-parser and sphinx dependencies to pyproject.toml
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.
This pull request introduces a new workflow for syncing the GitHub Wiki into the documentation build process, removes the dev container’s wiki mirroring logic, and updates documentation to reflect these changes. The most important changes are the addition of a GitHub Action for wiki sync, updates to Sphinx configuration to support Markdown wiki pages, and documentation updates to guide contributors on the new workflow.
Wiki Sync Workflow and Documentation Build Integration
.github/workflows/sync-wiki.yml) to automatically sync the GitHub Wiki intodocs/source/wiki/on pushes, PRs, a daily schedule, and manual triggers. Commits to the synced wiki occur only onmainto keep history clean.docs/source/conf.py) to support Markdown (myst_parser), include both.rstand.mdsources, and mock heavy dependencies for smoother docs builds. [1] [2] [3]myst-parserandsphinxas dependencies inpyproject.tomlfor local documentation builds.Documentation and Contributor Guidance
CONTRIBUTING.mdoutlining branching workflow, code style, testing, PR, and release process.README.md,AGENTS.md, anddocs/source/index.rstto describe the new CI-synced wiki workflow and remove references to the dev container wiki mirror. [1] [2] [3]docs/source/contributing/wiki-sync.mdto document the rationale and rules for the new wiki sync workflow.Dev Container Cleanup
.devcontainer/entrypoint.sh, simplifying container startup and eliminating the offline wiki sync feature.