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 writer] @definfoenclose is discouraged and raises warnings #9962

Closed
mitya57 opened this issue Dec 12, 2021 · 2 comments
Closed

[texinfo writer] @definfoenclose is discouraged and raises warnings #9962

mitya57 opened this issue Dec 12, 2021 · 2 comments

Comments

@mitya57
Copy link
Contributor

mitya57 commented Dec 12, 2021

Describe the bug

Sphinx uses @definfoenclose command here:

@definfoenclose strong,`,'
@definfoenclose emph,`,'

However the texinfo documentation says:

In practice, there is little use for this command, and we do not recommend you use it. Support for @definfoenclose may be removed in future releases of Texinfo.

And Texinfo prints these warnings when building documentation:

sphinx.texi:18: warning: @definfoenclose is obsolete.
sphinx.texi:19: warning: @definfoenclose is obsolete.

How to Reproduce

$ git clone https://github.com/sphinx-doc/sphinx.git
$ cd sphinx
$ pip install .
$ python ./sphinx/cmd/build.py -b texinfo doc doc/_build/texinfo
$ make -C doc/_build/texinfo info
make: Entering directory '/home/dmitry/upstream/sphinx/_build/texinfo'
makeinfo --no-split -o 'sphinx.info' 'sphinx.texi'
sphinx.texi:18: warning: @definfoenclose is obsolete.
sphinx.texi:19: warning: @definfoenclose is obsolete.
...

Expected behavior

No response

Your project

Reproducible with Sphinx itself

Screenshots

No response

OS

Linux

Python version

3.10

Sphinx version

4.3

Sphinx extensions

No response

Extra tools

No response

Additional context

No response

@tk0miya
Copy link
Member

tk0miya commented Dec 19, 2021

Thank you for your reporting.

Note: I found our docs introcuces a way to customize the style of emphasized texts. So we need to drop the command usage at v5.0.
https://www.sphinx-doc.org/en/master/faq.html#notes

@tk0miya tk0miya added this to the 5.0.0 milestone Dec 19, 2021
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 19, 2021
…string

Since texinfo-6.8, `@definfoenclose` command has been deprecated. This
stops to use it to reduce the deprecation warning.

This also disables the customization the styles of emphasized text via
the command.
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 19, 2021
…string

Since texinfo-6.8, `@definfoenclose` command has been deprecated. This
stops to use it to reduce the deprecation warning.

This also disables the customization the styles of emphasized text via
the command.
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 19, 2021
…string

Since texinfo-6.8, `@definfoenclose` command has been deprecated. This
stops to use it to reduce the deprecation warning.

This also disables the customization the styles of emphasized text via
the command.
tk0miya added a commit that referenced this issue Dec 22, 2021
Fix #9962: texinfo: Do not use @definfoenclose to empasize string
@tk0miya tk0miya modified the milestones: 5.0.0, 5.x May 2, 2022
@AA-Turner
Copy link
Member

Linked PR was merged.

A

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 23, 2022
@AA-Turner AA-Turner modified the milestones: 5.x, 5.0.0 Oct 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants