Repository navigation
Conversation
CybotTM
force-pushed
the
feature/mixed-input-formats
branch
from
November 8, 2026 19:52
fb07c98 to
34b569f
Compare
CybotTM
added a commit
to CybotTM/render-guides
that referenced
this pull request
Nov 8, 2026
phpDocumentor/guides#1448 lets input-format in guides.xml list several formats, such as "rst,md". Three places here assume one format. RunDecorator passes the entry file's format as --input-format, which overrides guides.xml and left out every Markdown page of an Index.rst manual. A configured list that contains the entry's format is now kept, once guides can read lists. The headline anchor check skips Markdown, and the entry file check names the file. Both now take the format from the file the page was parsed from instead of the project setting. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
CybotTM
force-pushed
the
feature/mixed-input-formats
branch
from
November 8, 2026 20:36
34b569f to
0de7f2a
Compare
Contributor
Author
|
CI fails here before the tests start because |
CybotTM
added a commit
to CybotTM/render-guides
that referenced
this pull request
Nov 8, 2026
phpDocumentor/guides#1448 lets input-format in guides.xml list several formats, such as "rst,md". Three places here assume one format. RunDecorator passes the entry file's format as --input-format, which overrides guides.xml and left out every Markdown page of an Index.rst manual. A configured list that contains the entry's format is now kept, once guides can read lists. The headline anchor check skips Markdown, and the entry file check names the file. Both now take the format from the file the page was parsed from instead of the project setting. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
CybotTM
force-pushed
the
feature/mixed-input-formats
branch
2 times, most recently
from
November 8, 2026 20:50
7654d73 to
8520e71
Compare
CybotTM
marked this pull request as ready for review
November 8, 2026 20:53
The input-format setting takes a comma-separated list. With "rst,md" every .rst file is parsed as reStructuredText and every .md file as Markdown, in one document tree. A single format behaves as before. Two files that differ only in their extension stop the run with an error naming both. Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
CybotTM
marked this pull request as draft
November 21, 2026 12:06
CybotTM
force-pushed
the
feature/mixed-input-formats
branch
from
November 21, 2026 12:06
8520e71 to
da6a40f
Compare
CybotTM
added a commit
to CybotTM/render-guides
that referenced
this pull request
Nov 21, 2026
phpDocumentor/guides#1448 lets input-format in guides.xml list several formats, such as "rst,md". Three places here assume one format. RunDecorator passes the entry file's format as --input-format, which overrides guides.xml and left out every Markdown page of an Index.rst manual. A configured list that contains the entry's format is now kept, once guides can read lists. The headline anchor check skips Markdown, and the entry file check names the file. Both now take the format from the file the page was parsed from instead of the project setting. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
CybotTM
marked this pull request as ready for review
November 21, 2026 12:55
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.
Merging this lets one project mix reStructuredText and Markdown files: with
input-format="rst,md", each.rstfile is parsed as reStructuredText and each.mdfile as Markdown, in one document tree. Projects with one input format render as before.The use case is a reStructuredText manual that also publishes documents kept in Markdown for other tools, such as specifications next to the code.
Known limits
includeof a file in the other format is not covered.guides-pagescalls the newParseDirectoryCommand::getInputFormats()andFiles::getExtension()while allowingphpdocumentor/guides ^1.0 || ^2.0, asguides-clidid withsetViolationFormat()in [FEATURE] Annotate problems in the documentation source in GitHub and GitLab #1434.ParseDirectoryCommand::getInputFormat()returns"rst,md"in a mixed project; listeners that use it as one extension should switch togetInputFormats().Testing
New fixture
tests/Integration/tests/configuration/config-mixed-input-formats: an RST index with a Markdown page in its toctree, links in both directions, an image and an excludedAGENTS.md. Also rendered a TYPO3 manual through render-guides with these files invendor/(TYPO3-Documentation/render-guides#1587).