Skip to content
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

texinfo: simplify reference emission. #9578

Merged

Conversation

marxin
Copy link
Contributor

@marxin marxin commented Aug 25, 2021

The commit adds a new config value 'texinfo_emit_document_references'
that blocks emission of inline references and make it better readable
with legacy stand-alone reader info.

Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.

while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.

It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info

@marxin marxin force-pushed the texinfo-add-texinfo_emit_document_references branch 3 times, most recently from 1186c21 to 07c93ee Compare August 25, 2021 09:49
@jakobandersen jakobandersen added builder:texinfo type:enhancement enhance or introduce a new feature labels Nov 6, 2021
@jakobandersen jakobandersen added this to the 4.3.0 milestone Nov 6, 2021
doc/usage/configuration.rst Outdated Show resolved Hide resolved
@jakobandersen
Copy link
Contributor

It addresses limitations mentioned in Sphinx' FAQ: https://www.sphinx-doc.org/en/master/faq.html#texinfo-info

Would it make sense to update that FAQ entry to mention this new confval?

As for the core part of this, I unfortunately don't know enough about texinfo to review it.

@marxin marxin force-pushed the texinfo-add-texinfo_emit_document_references branch 2 times, most recently from 640a08e to fc545ee Compare November 8, 2021 10:47
@marxin
Copy link
Contributor Author

marxin commented Nov 8, 2021

Would it make sense to update that FAQ entry to mention this new confval?

Yes, it makes fully sense and I've just done that.

Copy link
Member

@tk0miya tk0miya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with nits.

sphinx/writers/texinfo.py Outdated Show resolved Hide resolved
doc/usage/configuration.rst Outdated Show resolved Hide resolved
@tk0miya tk0miya modified the milestones: 4.3.0, 4.4.0 Nov 8, 2021
@marxin marxin force-pushed the texinfo-add-texinfo_emit_document_references branch 2 times, most recently from 6dec70e to f7d2eed Compare November 8, 2021 16:11
Copy link
Member

@tk0miya tk0miya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tk0miya
Copy link
Member

tk0miya commented Nov 8, 2021

I'll merge this into 4.3.0 release if @jakobandersen approves until X-Day.

@jakobandersen
Copy link
Contributor

I'll merge this into 4.3.0 release if @jakobandersen approves until X-Day.

Approved :-), my change request was just to get the .. versionadded updated to 4.3.

@marxin
Copy link
Contributor Author

marxin commented Nov 9, 2021

Approved :-)

Thanks for the approval.

The commit adds a new config value 'texinfo_emit_document_references'
that blocks the emission of inline references and make it better readable
with legacy stand-alone reader ``info``.

Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.

while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.

It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
@marxin marxin force-pushed the texinfo-add-texinfo_emit_document_references branch from f7d2eed to 9ec829f Compare November 12, 2021 13:01
@marxin
Copy link
Contributor Author

marxin commented Nov 12, 2021

Rebased for 4.4 release.

@tk0miya tk0miya merged commit 1832898 into sphinx-doc:4.x Dec 11, 2021
@tk0miya
Copy link
Member

tk0miya commented Dec 11, 2021

Merged. Thank you for your contribution!

tk0miya added a commit that referenced this pull request Dec 11, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 11, 2022
@marxin marxin deleted the texinfo-add-texinfo_emit_document_references branch June 17, 2022 11:11
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
builder:texinfo type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants