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

[DOC] src/doc/fr/tutorial/conf.py: remove obsolete latex work-around #39326

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

jfbu
Copy link
Contributor

@jfbu jfbu commented Jan 14, 2025

This work-around was needed with Pygments<1.0 hence has been obsolete for more than fifteen years.

Here is the relevant commit from Pygments:

commit 14b9433c05086beb67aca7436a96d1e685787d93
Author: Georg Brandl <[email protected]>
Date:   Fri Sep 12 00:28:08 2008 +0200

    Don't define \at, \lb, \rb as escapes, but prepend commandprefix here too.

Update: it is possible early-history Sphinx had some hardcoded things nowadays imported dynamically from Pygments such as the contents of the file sphinxhighlight.sty one finds in the latex build directory (which does currently \def\PYGZat{@}). Indeed I also found a similar commit at Sphinx,

commit 46544e4986fd2dbdf11d79897c18ef6623956db6
Author: Georg Brandl <[email protected]>
Date:   Thu Sep 11 22:29:35 2008 +0000

    Use a prefix to \at, \lb and \rb since they are probably often used command names.

which was part of Sphinx 0.5 release from November 2008. It is not fully clear to me why #8183 was raised in February 2010, but anyway I am very confident the issue does not exist at all if producing the PDF docs with a reasonable version of Sphinx.

There is another conf.py with this work-around but #39325 already handles it.

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

This work-around was needed with Pygments<1.0 hence is obsolete for more
than fifteen years.
@jfbu jfbu changed the title /src/doc/fr/tutorial/conf.py: remove obsolete latex work-around [DOC] src/doc/fr/tutorial/conf.py: remove obsolete latex work-around Jan 14, 2025
Copy link

github-actions bot commented Jan 15, 2025

Documentation preview for this PR (built with commit 4e16046; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

Copy link
Collaborator

@kwankyu kwankyu left a comment

Choose a reason for hiding this comment

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

OK. LGTM.

@jfbu
Copy link
Contributor Author

jfbu commented Jan 16, 2025

PR updated to apply the change also to the other French conf.py, as the latter is now not modified via current PR #39325

vbraun pushed a commit to vbraun/sage that referenced this pull request Jan 19, 2025
…latex work-around

    
This work-around was needed with Pygments<1.0 hence has been obsolete
for more than fifteen years.

Here is the [relevant commit](https://github.com/pygments/pygments/commi
t/14b9433c05086beb67aca7436a96d1e685787d93) from Pygments:
```text
commit 14b9433c05086beb67aca7436a96d1e685787d93
Author: Georg Brandl <[email protected]>
Date:   Fri Sep 12 00:28:08 2008 +0200

    Don't define \at, \lb, \rb as escapes, but prepend commandprefix
here too.
```

Update: it is possible early-history Sphinx had some hardcoded things
nowadays imported dynamically from Pygments such as  the contents of the
file `sphinxhighlight.sty` one finds in the latex build directory (which
does currently `\def\PYGZat{@}`).  Indeed I also found a [similar commit
at Sphinx](https://github.com/sphinx-
doc/sphinx/commit/46544e4986fd2dbdf11d79897c18ef6623956db6),
```text
commit 46544e4986fd2dbdf11d79897c18ef6623956db6
Author: Georg Brandl <[email protected]>
Date:   Thu Sep 11 22:29:35 2008 +0000

    Use a prefix to \at, \lb and \rb since they are probably often used
command names.

```
which was part of [Sphinx 0.5 release](https://github.com/sphinx-
doc/sphinx/releases/tag/v0.5) from November 2008. It is  not fully clear
to me why sagemath#8183 was raised in February 2010, but anyway I am very
confident the issue does not exist at all if producing the PDF docs with
a reasonable version of Sphinx.

There is another conf.py with this work-around but sagemath#39325 already
handles it.

<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->



### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#39326
Reported by: Jean-François B.
Reviewer(s): Kwankyu Lee
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants