sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.32k stars 453 forks source link

deTeX document titles of sage documentation #33475

Closed kwankyu closed 2 years ago

kwankyu commented 2 years ago

We remove \(, \), \, $ from the documentation title.

Component: documentation

Author: Kwankyu Lee

Branch/Commit: 7da2b5f

Reviewer: John Palmieri

Issue created by migration from https://trac.sagemath.org/ticket/33475

kwankyu commented 2 years ago

Description changed:

--- 
+++ 
@@ -1 +1 @@
-
+We remove ugly `\(`, `\)`, `\` from the documentation title.
kwankyu commented 2 years ago

Branch: u/klee/33475

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

f3d3fdadeTeX documentation title
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Commit: f3d3fda

jhpalmieri commented 2 years ago
comment:4

It's much better this way, thank you. It's not perfect but it probably will never be without actually parsing the LaTeX: a page like https://doc.sagemath.org/html/en/reference/arithgroup/index.html will still end up with a title {rm SL}_2{{bf Z}}. Actually it would be better if whoever originally wrote that had defined a macro \SL and also used the existing macro \ZZ.

In the big change in layout.html (when I view the branch here), is it a change in indentation or is there an actual difference in content?

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from f3d3fda to 528ef65

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

528ef65Use new commands \SL and \PSL
kwankyu commented 2 years ago
comment:6

Replying to @jhpalmieri:

It's much better this way, thank you. It's not perfect but it probably will never be without actually parsing the LaTeX.

Right.

a page like https://doc.sagemath.org/html/en/reference/arithgroup/index.html will still end up with a title {rm SL}_2{{bf Z}}. Actually it would be better if whoever originally wrote that had defined a macro \SL and also used the existing macro \ZZ.

While solving this, I ended up in adding new macros \SL and \PSL.

In the big change in layout.html (when I view the branch here), is it a change in indentation or is there an actual difference in content?

They are all just indentation changes to align them up.

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

9187bf1Fix a glitch
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from 528ef65 to 9187bf1

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

eff36ecFix another glitch
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from 9187bf1 to eff36ec

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from eff36ec to fe4811c

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

fe4811cFix doctest failures
kwankyu commented 2 years ago

Description changed:

--- 
+++ 
@@ -1 +1 @@
-We remove ugly `\(`, `\)`, `\` from the documentation title.
+We remove `\(`, `\)`, `\`, `$` from the documentation title.
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from fe4811c to 7285ad3

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

7285ad3Fix more doctest failures
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from 7285ad3 to 11ed990

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

11ed990Speed up macro parsing
jhpalmieri commented 2 years ago
comment:13

As before, I think it looks great. Do you want to keep tinkering, fixing small issues, or should we merge it and move on? By "small issues," I mean that if I visit the local version of ​https://doc.sagemath.org/html/en/reference/arithgroup/index.html, then the title bar says "Arithmetic Subgroups of SL_2(ZZ) — Arithmetic Subgroups of $SL_2(ZZ)$", and similarly when I follow links from that page. I don't know where the dollar signs are coming from, and I don't know if it's worth tracking down. (That's the only type of issue I've seen so far.)

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

7da2b5fFix an error in removing $
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from 11ed990 to 7da2b5f

kwankyu commented 2 years ago
comment:15

Replying to @jhpalmieri:

As before, I think it looks great. Do you want to keep tinkering, fixing small issues, or should we merge it and move on? By "small issues," I mean that if I visit the local version of ​https://doc.sagemath.org/html/en/reference/arithgroup/index.html, then the title bar says "Arithmetic Subgroups of SL_2(ZZ) — Arithmetic Subgroups of $SL_2(ZZ)$", and similarly when I follow links from that page. I don't know where the dollar signs are coming from, and I don't know if it's worth tracking down. (That's the only type of issue I've seen so far.)

I don't know either. But those $ dollars should have been removed. The last commit would fix the error.

I have no more things to do. Thanks for reviewing.

jhpalmieri commented 2 years ago

Reviewer: John Palmieri

jhpalmieri commented 2 years ago
comment:16

Great, thank you for fixing this!

vbraun commented 2 years ago

Changed branch from u/klee/33475 to 7da2b5f