Add links to sources in documentation

src/doc/ca/intro/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/ca/intro', '{filename}'),
+})
+
 # General information about the project.
 project = "Introducció de Sage"
 

src/doc/common/static/custom-furo.css

@@ -21,3 +21,17 @@ a.pdf:hover {
   text-decoration: none;
 }
 
+/* Style for announcement banner */
+
+.announcement {
+    background: orange;
+}
+
+.announcement-content {
+    color: black;
+}
+
+.announcement-content a {
+    color: white;
+    text-decoration: none;
+}

src/doc/de/a_tour_of_sage/conf.py

@@ -22,6 +22,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/de/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = "Ein Rundgang durch Sage"
 name = "a_tour_of_sage"

src/doc/de/thematische_anleitungen/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/de/thematische_anleitungen', '{filename}'),
+})
+
 # General information about the project.
 project = "Thematische Anleitungen"
 name = 'ThematischeAnleitungen-de'

src/doc/de/tutorial/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/de/tutorial', '{filename}'),
+})
+
 # General information about the project.
 project = "Sage Tutorial"
 name = 'SageTutorial-de'

src/doc/en/a_tour_of_sage/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, f'blob/develop/src/doc/en/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = "A Tour of Sage"
 

src/doc/en/constructions/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/constructions', '{filename}'),
+})
+
 # General information about the project.
 project = "Constructions"
 

src/doc/en/developer/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/developer', '{filename}'),
+})
+
 # General information about the project.
 project = "Developer Guide"
 

src/doc/en/faq/conf.py

@@ -22,6 +22,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/faq', '{filename}'),
+})
+
 # General information about the project.
 project = "FAQ"
 

src/doc/en/installation/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/installation', '{filename}'),
+})
+
 # General information about the project.
 project = "Installation Guide"
 

src/doc/en/prep/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/prep', '{filename}'),
+})
+
 # General information about the project.
 project = "PREP Tutorials"
 copyright = "2012, Rob Beezer, Karl-Dieter Crisman, and Jason Grout"

src/doc/en/reference/conf.py

@@ -25,6 +25,11 @@
 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.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/reference/index.rst'),
+})
+
 # General information about the project.
 project = "Reference Manual"
 

src/doc/en/reference/conf_sub.py

@@ -42,6 +42,11 @@
     title = name.capitalize()
 title = title.replace('`', '$')
 
+# We use the directory's name to add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, f'blob/develop/src/doc/en/reference/{name}', '{filename}'),
+})
+
 # General information about the project.
 project = title
 

src/doc/en/thematic_tutorials/conf.py

@@ -22,6 +22,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/thematic_tutorials', '{filename}'),
+})
+
 # General information about the project.
 project = "Thematic Tutorials"
 

src/doc/en/tutorial/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/en/tutorial', '{filename}'),
+})
+
 # General information about the project.
 project = "Tutorial"
 

src/doc/es/a_tour_of_sage/conf.py

@@ -22,6 +22,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/es/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = 'Un Tour Por Sage'
 name = 'a_tour_of_sage'

src/doc/es/tutorial/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/es/tutorial', '{filename}'),
+})
+
 # General information about the project.
 project = "Sage Tutorial"
 name = 'tutorial-es'

src/doc/fr/a_tour_of_sage/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/fr/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = 'Sage en quelques mots'
 name = 'a_tour_of_sage'

src/doc/fr/tutorial/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/fr/tutorial', '{filename}'),
+})
+
 # General information about the project.
 project = "Tutoriel Sage"
 name = 'tutorial-fr'

src/doc/hu/a_tour_of_sage/conf.py

@@ -22,6 +22,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/hu/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = 'A Sage bemutatása'
 name = 'a_tour_of_sage'

src/doc/it/a_tour_of_sage/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/it/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = 'Esplora Sage'
 name = 'a_tour_of_sage'

src/doc/it/faq/conf.py

@@ -22,6 +22,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/it/faq', '{filename}'),
+})
+
 # General information about the project.
 project = "Sage FAQ"
 

src/doc/it/tutorial/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/it/tutorial', '{filename}'),
+})
+
 # General information about the project.
 project = "Tutorial Sage"
 name = 'tutorial-it'

src/doc/ja/a_tour_of_sage/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/ja/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = "Sage ガイドツアー"
 name = 'a_tour_of_sage'

src/doc/ja/tutorial/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/ja/tutorial', '{filename}'),
+})
+
 # General information about the project.
 project = "Sage チュートリアル"
 name = 'tutorial-jp'

src/doc/pt/a_tour_of_sage/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/pt/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = 'Uma Turnê pelo Sage'
 name = 'a_tour_of_sage'

src/doc/pt/tutorial/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/pt/tutorial', '{filename}'),
+})
+
 # General information about the project.
 project = "Tutorial Sage"
 name = 'tutorial-pt'

src/doc/ru/tutorial/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, 'blob/develop/src/doc/ru/tutorial', '{filename}'),
+})
+
 # General information about the project.
 project = "Sage Tutorial in Russian"
 name = 'tutorial-ru'

src/doc/tr/a_tour_of_sage/conf.py

@@ -20,6 +20,11 @@
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+# Add a small edit button.
+html_theme_options.update({
+  'source_edit_link': os.path.join(source_repository, f'blob/develop/src/doc/tr/a_tour_of_sage', '{filename}'),
+})
+
 # General information about the project.
 project = 'Sage Turu'
 name = 'a_tour_of_sage'