Skip to content

Remove spurious diffs in doc previews #40595

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

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/doc-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ jobs:
path: ~/conda_pkgs_dir
key:
${{ runner.os }}-conda-${{ hashFiles('environment-${{ env.PYTHON_VERSION }}-linux.yml') }}

- name: Compiler cache
uses: hendrikmuhs/[email protected]
with:
Expand All @@ -62,7 +62,7 @@ jobs:
channel-priority: true
activate-environment: sage-dev
environment-file: environment-${{ env.PYTHON_VERSION }}-linux.yml

- name: Build Sage
shell: bash -l {0}
run: |
Expand Down Expand Up @@ -123,6 +123,7 @@ jobs:
-e 's;#L[0-9]*";";' \
-e 's;tab-set--[0-9]*-;tab-set-;g' \
-e 's;"tab-set--[0-9]*";"tab-set";' \
-e 's/0x[0-9a-fA-F]*>/0x12345678\>/' \
&& true)
# If the regex list above is changed, the sed command in "Copy doc" step should also be changed
# Create git repo from old doc
Expand Down Expand Up @@ -168,6 +169,7 @@ jobs:
-e 's;#L[0-9]*";";' \
-e 's;tab-set--[0-9]*-;tab-set-;g' \
-e 's;"tab-set--[0-9]*";"tab-set";' \
-e 's/0x[0-9a-fA-F]*>/0x12345678\>/' \
&& git commit -a -m 'wipe-out')
# If the regex list above is changed, the sed command in "Store old doc" step should also be changed
# Since HEAD is at commit 'wipe-out', HEAD~1 is commit 'new' (new doc), HEAD~2 is commit 'old' (old doc)
Expand Down
6 changes: 3 additions & 3 deletions src/doc/ca/intro/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
# General information about the project.
project = "Introducció de Sage"

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

# Output file base name for HTML help builder.
htmlhelp_basename = 'TutorialdeSage'
Expand Down
7 changes: 3 additions & 4 deletions src/doc/de/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@
name = "a_tour_of_sage"
language = 'de'

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
6 changes: 3 additions & 3 deletions src/doc/de/thematische_anleitungen/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
name = 'ThematischeAnleitungen-de'
language = "de"

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
6 changes: 3 additions & 3 deletions src/doc/de/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
name = 'SageTutorial-de'
language = "de"

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
6 changes: 3 additions & 3 deletions src/doc/el/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
name = 'a_tour_of_sage'
language = 'el'

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
3 changes: 1 addition & 2 deletions src/doc/en/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@
# General information about the project.
project = "A Tour of Sage"

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

Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/constructions/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
# General information about the project.
project = "Constructions"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/developer/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
# General information about the project.
project = "Developer Guide"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/faq/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
# General information about the project.
project = "FAQ"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/installation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
# General information about the project.
project = "Installation Guide"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/prep/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
project = "PREP Tutorials"
copyright = "2012, Rob Beezer, Karl-Dieter Crisman, and Jason Grout"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/reference/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
# General information about the project.
project = "Reference Manual"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/thematic_tutorials/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
# General information about the project.
project = "Thematic Tutorials"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Three Lectures about Explicit Methods in Number Theory Using Sage
=================================================================

.. MODULEAUTHOR:: William Stein (2008)

This article is about using the mathematical software Sage to do
computations with number fields and modular forms. It was written
for the October 2008 Bordeaux meeting on explicit methods in number
Expand Down
42 changes: 0 additions & 42 deletions src/doc/en/thematic_tutorials/numerical_sage/conf.py

This file was deleted.

2 changes: 2 additions & 0 deletions src/doc/en/thematic_tutorials/numerical_sage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Numerical Computing with Sage

Beware that this document may be obsolete.

.. MODULEAUTHOR:: Josh Kantor (2008)

This document is designed to introduce the reader to the tools in Sage
that are useful for doing numerical computation. By numerical
computation we essentially mean machine precision floating point
Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
# General information about the project.
project = "Tutorial"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down
2 changes: 1 addition & 1 deletion src/doc/en/website/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# General information about the project.
project = "Documentation"

# The name for this set of Sphinx documents.
# The name for this set of Sphinx documents. Do not include release info.
html_title = project
html_short_title = project

Expand Down
7 changes: 3 additions & 4 deletions src/doc/es/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@
name = 'a_tour_of_sage'
language = 'es'

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
6 changes: 3 additions & 3 deletions src/doc/es/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
name = 'tutorial-es'
language = "es"

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

# Output file base name for HTML help builder.
htmlhelp_basename = 'SageTutorial'
Expand Down
6 changes: 3 additions & 3 deletions src/doc/fr/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
name = 'a_tour_of_sage'
language = 'fr'

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
6 changes: 3 additions & 3 deletions src/doc/fr/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
name = 'tutorial-fr'
language = "fr"

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
7 changes: 3 additions & 4 deletions src/doc/hu/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@
name = 'a_tour_of_sage'
language = 'hu'

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
7 changes: 3 additions & 4 deletions src/doc/it/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@
name = 'a_tour_of_sage'
language = 'it'

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

# Output file base name for HTML help builder.
htmlhelp_basename = name
Expand Down
6 changes: 3 additions & 3 deletions src/doc/it/faq/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
# General information about the project.
project = "Sage FAQ"

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

# Output file base name for HTML help builder.
htmlhelp_basename = "faq"
Expand Down
Loading
Loading