Skip to content

Commit

Permalink
sagemathgh-38451: Add view/edit buttons to docs
Browse files Browse the repository at this point in the history
    
<!-- ^ 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". -->

Updated furo theme now provides view/edit buttons. We adapt our docs.

Upgrade furo to the latest version with a bug fix.

### 📝 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,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38451
Reported by: Kwankyu Lee
Reviewer(s):
  • Loading branch information
Release Manager committed Aug 2, 2024
2 parents f5983c7 + 298fd66 commit 270177b
Show file tree
Hide file tree
Showing 32 changed files with 97 additions and 62 deletions.
4 changes: 2 additions & 2 deletions build/pkgs/furo/checksums.ini
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tarball=furo-VERSION-py3-none-any.whl
sha1=f43dad408126f23ec5c480ad993e42335ca47713
sha256=490a00d08c0a37ecc90de03ae9227e8eb5d6f7f750edf9807f398a2bdf2358de
sha1=de4aa7aff48696580d62abed717bf1c309af10f5
sha256=b192c7c1f59805494c8ed606d9375fdac6e6ba8178e747e72bc116745fb7e13f
upstream_url=https://pypi.io/packages/py3/f/furo/furo-VERSION-py3-none-any.whl
2 changes: 1 addition & 1 deletion build/pkgs/furo/package-version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024.5.6
2024.7.18
5 changes: 3 additions & 2 deletions src/doc/ca/intro/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/ca/intro', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/ca/intro', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/ca/intro', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/de/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/de/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/de/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/de/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/de/thematische_anleitungen/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/de/thematische_anleitungen', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/de/thematische_anleitungen', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/de/thematische_anleitungen', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/de/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/de/tutorial', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/de/tutorial', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/de/tutorial', '{filename}'),
})

# General information about the project.
Expand Down
6 changes: 6 additions & 0 deletions src/doc/el/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add small view/edit buttons.
html_theme_options.update({
'source_view_link': os.path.join(source_repository, f'blob/develop/src/doc/el/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, f'edit/develop/src/doc/el/a_tour_of_sage', '{filename}'),
})

# General information about the project.
project = 'Περιήγηση στο Sage'
name = 'a_tour_of_sage'
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, f'blob/develop/src/doc/en/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, f'blob/develop/src/doc/en/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, f'edit/develop/src/doc/en/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/constructions/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/constructions', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/en/constructions', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/en/constructions', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/developer/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/developer', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/en/developer', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/en/developer', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/faq/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/faq', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/en/faq', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/en/faq', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/installation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/installation', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/en/installation', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/en/installation', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/prep/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/prep', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/en/prep', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/en/prep', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/reference/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@
ref_src = os.path.join(SAGE_DOC_SRC, 'en', 'reference')
ref_out = os.path.join(SAGE_DOC, 'html', 'en', 'reference')

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/reference/index.rst'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/en/reference/index.rst'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/en/reference/index.rst'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/reference/conf_sub.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@
title = name.capitalize()
title = title.replace('`', '$')

# We use the directory's name to add a small edit button.
# We use the directory's name to add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, f'blob/develop/src/doc/en/reference/{name}', '{filename}'),
'source_view_link': os.path.join(source_repository, f'blob/develop/src/doc/en/reference/{name}', '{filename}'),
'source_edit_link': os.path.join(source_repository, f'edit/develop/src/doc/en/reference/{name}', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/thematic_tutorials/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/thematic_tutorials', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/en/thematic_tutorials', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/en/thematic_tutorials', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/en/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/tutorial', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/en/tutorial', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/en/tutorial', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/es/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/es/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/es/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/es/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/es/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/es/tutorial', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/es/tutorial', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/es/tutorial', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/fr/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/fr/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/fr/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/fr/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/fr/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/fr/tutorial', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/fr/tutorial', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/fr/tutorial', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/hu/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/hu/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/hu/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/hu/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/it/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/it/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/it/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/it/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/it/faq/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/it/faq', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/it/faq', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/it/faq', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/it/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/it/tutorial', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/it/tutorial', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/it/tutorial', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/ja/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/ja/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/ja/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/ja/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/ja/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/ja/tutorial', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/ja/tutorial', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/ja/tutorial', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/pt/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/pt/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/pt/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/pt/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/pt/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/pt/tutorial', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/pt/tutorial', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/pt/tutorial', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/ru/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/ru/tutorial', '{filename}'),
'source_view_link': os.path.join(source_repository, 'blob/develop/src/doc/ru/tutorial', '{filename}'),
'source_edit_link': os.path.join(source_repository, 'edit/develop/src/doc/ru/tutorial', '{filename}'),
})

# General information about the project.
Expand Down
5 changes: 3 additions & 2 deletions src/doc/tr/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@
# contains common paths.
html_static_path = [] + html_common_static_path

# Add a small edit button.
# Add small view/edit buttons.
html_theme_options.update({
'source_edit_link': os.path.join(source_repository, f'blob/develop/src/doc/tr/a_tour_of_sage', '{filename}'),
'source_view_link': os.path.join(source_repository, f'blob/develop/src/doc/tr/a_tour_of_sage', '{filename}'),
'source_edit_link': os.path.join(source_repository, f'edit/develop/src/doc/tr/a_tour_of_sage', '{filename}'),
})

# General information about the project.
Expand Down
Loading

0 comments on commit 270177b

Please sign in to comment.