Merge pull request #1232 from gusthoff/topic/infrastructure/sphinx/structure/20250606/furo_theme

Sphinx: migrating to Furo theme

Author: gusthoff

frontend/requirements.txt

@@ -1,5 +1,6 @@
 coverage==7.8.0
 docutils==0.21.2
+furo==2024.8.6
 graphviz==0.20.3
 ipython==9.1.0
 pdf2image==1.17.0

frontend/requirements_frozen.txt

@@ -1,12 +1,14 @@
 alabaster==1.0.0
 asttokens==3.0.0
 babel==2.17.0
+beautifulsoup4==4.13.4
 certifi==2025.1.31
 charset-normalizer==3.4.1
 coverage==7.8.0
 decorator==5.2.1
 docutils==0.21.2
 executing==2.2.0
+furo==2024.8.6
 graphviz==0.20.3
 idna==3.10
 imagesize==1.4.1
@@ -36,8 +38,10 @@ roman-numerals-py==3.1.0
 setuptools==79.0.1
 six==1.17.0
 snowballstemmer==2.2.0
+soupsieve==2.7
 Sphinx==8.1.3
 sphinx-reredirects==0.1.6
+sphinx-basic-ng==1.0.0b2
 sphinx-rtd-theme==3.0.2
 sphinxcontrib-applehelp==2.0.0
 sphinxcontrib-bibtex==2.6.3

frontend/sphinx/_templates/footer.html

@@ -104,7 +104,6 @@ def get_file_from_conf_ini(path_to_file):
     'sphinx.ext.graphviz',
     'sphinx.ext.extlinks',
     'widget_extension',
-    'sphinx_rtd_theme',
     'sphinx_reredirects',
     'sphinxcontrib.plantuml',
 ]
@@ -183,6 +182,7 @@ def get_file_from_conf_ini(path_to_file):
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
+pygments_dark_style = "monokai"
 
 nitpicky = True
 
@@ -232,8 +232,7 @@ def get_file_from_conf_ini(path_to_file):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-#html_theme = 'learn_theme'
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 
 if 'GEN_LEARN_SITE' in os.environ and os.environ['GEN_LEARN_SITE'] == "yes":
     html_title = "learn.adacore.com"
@@ -245,24 +244,32 @@ def get_file_from_conf_ini(path_to_file):
 
 html_theme_path = ['.'] # make sphinx search for themes in current dir
 
+html_css_files = [
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css",
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css",
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
+]
+
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 html_theme_options = {
-    'logo_only': True,
-    'flyout_display': 'hidden',
-    'version_selector': False,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
-    'vcs_pageview_mode': '',
-#    'style_nav_header_background': 'white',
-    # Toc options
-    'collapse_navigation': False,
-    'sticky_navigation': False,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    # furo options
+
+    # 'light_css_variables': {
+    # },
+    # 'dark_css_variables': {
+    # }
+    'sidebar_hide_name': True,
+    'navigation_with_keys': True,
+    'top_of_page_buttons': ["view", "edit"],
+    # 'announcement': "",
+    # 'footer_icons': [],
+
+    "source_repository": "https://github.com/AdaCore/learn",
+    "source_branch": "master",
+    "source_directory": "content/",
 }
 
 html_show_sphinx = False
@@ -271,6 +278,9 @@ def get_file_from_conf_ini(path_to_file):
     html_logo = "img/logo.svg"
 else:
     html_logo = "img/logo_sandbox.svg"
+    html_theme_options["announcement"] = \
+        "<p>⚠️ This version of the website contains UNPUBLISHED contents. " \
+        "⚠️</p>"
 
 html_favicon = "img/favicon.ico"