- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
autosummary may output .md files with MyST-Parser #12147
Labels
Comments
kou
added a commit
to kou/sphinx
that referenced
this issue
Mar 20, 2024
fix sphinx-doc#12147 `SphinxComponentRegistry.source_parsers` uses `rst`, `md` and so on (without `.`) as key but `source_suffix` in `conf.py` uses `.rst`, `md` and so on (with `.`) as key. So we need to remove preceding `.` from suffixes from `source_suffix` to detect supported format from `SphinxComponentRegistry.source_parsers`.
This was referenced Mar 20, 2024
kou
added a commit
to kou/sphinx
that referenced
this issue
Mar 21, 2024
fix sphinx-doc#12147 `SphinxComponentRegistry.source_parsers` uses `rst`, `md` and so on (without `.`) as key but `source_suffix` in `conf.py` uses `.rst`, `md` and so on (with `.`) as key. So we need to remove preceding `.` from suffixes from `source_suffix` to detect supported format from `SphinxComponentRegistry.source_parsers`.
kou
added a commit
to kou/sphinx
that referenced
this issue
Mar 21, 2024
fix sphinx-doc#12147 `SphinxComponentRegistry.source_parsers` uses `rst`, `md` and so on (without `.`) as key but `source_suffix` in `conf.py` uses `.rst`, `md` and so on (with `.`) as key. So we need to remove preceding `.` from suffixes from `source_suffix` to detect supported format from `SphinxComponentRegistry.source_parsers`.
kou
added a commit
to kou/sphinx
that referenced
this issue
Mar 22, 2024
fix sphinx-doc#12147 `SphinxComponentRegistry.source_parsers` uses `rst`, `md` and so on (without `.`) as key but `source_suffix` in `conf.py` uses `.rst`, `md` and so on (with `.`) as key. So we need to remove preceding `.` from suffixes from `source_suffix` to detect supported format from `SphinxComponentRegistry.source_parsers`.
kou
added a commit
to kou/sphinx
that referenced
this issue
Mar 22, 2024
fix sphinx-doc#12147 `SphinxComponentRegistry.source_parsers` uses `rst`, `md` and so on (without `.`) as key but `source_suffix` in `conf.py` uses `.rst`, `md` and so on (with `.`) as key. So we need to remove preceding `.` from suffixes from `source_suffix` to detect supported format from `SphinxComponentRegistry.source_parsers`.
kou
added a commit
to kou/arrow
that referenced
this issue
Mar 22, 2024
Loading
Loading status checks…
This is a workaround of sphinx-doc/sphinx#12147 .
AlenkaF
pushed a commit
to apache/arrow
that referenced
this issue
Mar 25, 2024
Loading
Loading status checks…
### Rationale for this change Sphinx < 7.3.0 has a problem that auto generated files may use wrong suffix. See sphinx-doc/sphinx#12147 for details. ### What changes are included in this PR? Use `.rst` as the first `source_suffix` item as a workaround of this problem. ### Are these changes tested? Yes. ### Are there any user-facing changes? Yes. * GitHub Issue: #40623 Authored-by: Sutou Kouhei <kou@clear-code.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Describe the bug
If we have the following configurations, autosummary generates
.md
files with reST content:autosummary should generate
.rst
files because they use reST.Note that if we use the following order for
source_suffix
, autosummary generates.md
files:How to Reproduce
Create a new project:
$ sphinx-quickstart /tmp/sphinx-test
Add the following configurations to
conf.py
:Add the following content to
index.rst
:Generate document:
$ make -C /tmp/sphinx-test html
Check generated files:
It has
.md
suffix not.rst
suffix.Environment Information
Sphinx extensions
Additional context
No response
The text was updated successfully, but these errors were encountered: