Assess optional Markdown output strategy for Sphinx/ReadTheDocs docs build#171
Draft
Assess optional Markdown output strategy for Sphinx/ReadTheDocs docs build#171
Conversation
Copilot
AI
changed the title
[WIP] Investigate optional markdown output for documentation
Assess optional Markdown output strategy for Sphinx/ReadTheDocs docs build
Apr 6, 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.
This issue asked whether the docs build can optionally emit Markdown instead of the current HTML output, and how difficult that would be. This PR captures a feasibility assessment and implementation plan without introducing behavior changes yet.
Current state analysis
sphinx==3.0.0.make html/ Sphinx HTML builders), with RTD also configured for PDF.Markdown feasibility findings
Implementation options proposed
Recommended execution plan
make markdown) only if output quality is acceptable; otherwise proceed to Option B.