Skip to content

Commit 2272ab7

Browse files
author
Release Manager
committed
gh-40595: Remove spurious diffs in doc previews Again some spurious diffs crawled in. We remove them. For example, https://doc-pr-40586--sagemath.netlify.app/changes A sage doc needs to avoid release info in title. I suspect that release info in title is a source of spurious diffs. (I think I saw them in a doc preview changes somewhere, but I cannot find where now...) Anyway the release info is redundant. Two unused `conf.py` are deleted. <!-- ^ 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 #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 #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. - [ ] 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, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> URL: #40595 Reported by: Kwankyu Lee Reviewer(s):
2 parents 91b1b76 + ad9c046 commit 2272ab7

File tree

36 files changed

+81
-166
lines changed

36 files changed

+81
-166
lines changed

‎.github/workflows/doc-build.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
path: ~/conda_pkgs_dir
4545
key:
4646
${{ runner.os }}-conda-${{ hashFiles('environment-${{ env.PYTHON_VERSION }}-linux.yml') }}
47-
47+
4848
- name: Compiler cache
4949
uses: hendrikmuhs/[email protected]
5050
with:
@@ -62,7 +62,7 @@ jobs:
6262
channel-priority: true
6363
activate-environment: sage-dev
6464
environment-file: environment-${{ env.PYTHON_VERSION }}-linux.yml
65-
65+
6666
- name: Build Sage
6767
shell: bash -l {0}
6868
run: |
@@ -123,6 +123,7 @@ jobs:
123123
-e 's;#L[0-9]*";";' \
124124
-e 's;tab-set--[0-9]*-;tab-set-;g' \
125125
-e 's;"tab-set--[0-9]*";"tab-set";' \
126+
-e 's/0x[0-9a-fA-F]*&gt;/0x12345678\&gt;/' \
126127
&& true)
127128
# If the regex list above is changed, the sed command in "Copy doc" step should also be changed
128129
# Create git repo from old doc
@@ -168,6 +169,7 @@ jobs:
168169
-e 's;#L[0-9]*";";' \
169170
-e 's;tab-set--[0-9]*-;tab-set-;g' \
170171
-e 's;"tab-set--[0-9]*";"tab-set";' \
172+
-e 's/0x[0-9a-fA-F]*&gt;/0x12345678\&gt;/' \
171173
&& git commit -a -m 'wipe-out')
172174
# If the regex list above is changed, the sed command in "Store old doc" step should also be changed
173175
# Since HEAD is at commit 'wipe-out', HEAD~1 is commit 'new' (new doc), HEAD~2 is commit 'old' (old doc)

‎src/doc/ca/intro/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@
2929
# General information about the project.
3030
project = "Introducció de Sage"
3131

32-
# The name for this set of Sphinx documents. If None, it defaults to
33-
# "<project> v<release> documentation".
34-
html_title = project + " v"+release
32+
# The name for this set of Sphinx documents. Do not include release info.
33+
html_title = project
34+
html_short_title = project
3535

3636
# Output file base name for HTML help builder.
3737
htmlhelp_basename = 'TutorialdeSage'

‎src/doc/de/a_tour_of_sage/conf.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,9 @@
3333
name = "a_tour_of_sage"
3434
language = 'de'
3535

36-
# The name for this set of Sphinx documents. If None, it defaults to
37-
# "<project> v<release> documentation".
38-
html_title = project + " v" + release
39-
html_short_title = "Sage Rundgang v" + release
36+
# The name for this set of Sphinx documents. Do not include release info.
37+
html_title = project
38+
html_short_title = "Sage Rundgang"
4039

4140
# Output file base name for HTML help builder.
4241
htmlhelp_basename = name

‎src/doc/de/thematische_anleitungen/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
name = 'ThematischeAnleitungen-de'
3232
language = "de"
3333

34-
# The name for this set of Sphinx documents. If None, it defaults to
35-
# "<project> v<release> documentation".
36-
html_title = project + " v" + release
34+
# The name for this set of Sphinx documents. Do not include release info.
35+
html_title = project
36+
html_short_title = project
3737

3838
# Output file base name for HTML help builder.
3939
htmlhelp_basename = name

‎src/doc/de/tutorial/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
name = 'SageTutorial-de'
3232
language = "de"
3333

34-
# The name for this set of Sphinx documents. If None, it defaults to
35-
# "<project> v<release> documentation".
36-
html_title = project + " v"+release
34+
# The name for this set of Sphinx documents. Do not include release info.
35+
html_title = project
36+
html_short_title = project
3737

3838
# Output file base name for HTML help builder.
3939
htmlhelp_basename = name

‎src/doc/el/a_tour_of_sage/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
name = 'a_tour_of_sage'
3232
language = 'el'
3333

34-
# The name for this set of Sphinx documents. If None, it defaults to
35-
# "<project> v<release> documentation".
36-
html_title = project + ' v' + release
34+
# The name for this set of Sphinx documents. Do not include release info.
35+
html_title = project
36+
html_short_title = project
3737

3838
# Output file base name for HTML help builder.
3939
htmlhelp_basename = name

‎src/doc/en/a_tour_of_sage/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@
2929
# General information about the project.
3030
project = "A Tour of Sage"
3131

32-
# The name for this set of Sphinx documents. If None, it defaults to
33-
# "<project> v<release> documentation".
32+
# The name for this set of Sphinx documents. Do not include release info.
3433
html_title = project
3534
html_short_title = project
3635

‎src/doc/en/constructions/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
# General information about the project.
3030
project = "Constructions"
3131

32-
# The name for this set of Sphinx documents.
32+
# The name for this set of Sphinx documents. Do not include release info.
3333
html_title = project
3434
html_short_title = project
3535

‎src/doc/en/developer/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
# General information about the project.
3030
project = "Developer Guide"
3131

32-
# The name for this set of Sphinx documents.
32+
# The name for this set of Sphinx documents. Do not include release info.
3333
html_title = project
3434
html_short_title = project
3535

‎src/doc/en/faq/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
# General information about the project.
3232
project = "FAQ"
3333

34-
# The name for this set of Sphinx documents.
34+
# The name for this set of Sphinx documents. Do not include release info.
3535
html_title = project
3636
html_short_title = project
3737

0 commit comments

Comments
 (0)