Update ReadTheDocs to align more with other Sumo repos look (#298)

* Update ReadTheDocs to align more with other Sumo repos look * WIP
equinor · Feb 22, 2024 · 915b21e · 915b21e
1 parent 3360d57
commit 915b21e
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 57 deletions.
diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml
@@ -1,5 +1,6 @@
-# build and test some end points
-name: Build and deploy docs for fmu-sumo
+# build documentation
+# Deploy of doc is configured from ReadTheDocs
+name: Build docs for fmu-sumo
 
 on:
   pull_request:

diff --git a/docs/_static/equinor-logo.png b/docs/_static/equinor-logo.png
diff --git a/docs/_static/equinor-logo2.jpg b/docs/_static/equinor-logo2.jpg
diff --git a/docs/_static/equinor_logo.jpg b/docs/_static/equinor_logo.jpg
diff --git a/docs/_static/equinor_logo_only.jpg b/docs/_static/equinor_logo_only.jpg
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -0,0 +1,17 @@
+{% extends "!layout.html" %}
+  {% block footer %} {{ super() }}
+
+  <style>
+    /* Sidebar header (and topbar for mobile) */
+    .wy-side-nav-search, .wy-nav-top {
+      background: #ff1243;
+    }
+    /* Sidebar */
+    .wy-nav-side {
+      background: #474747;
+    }
+    .wy-side-nav-search > div.version {
+      color: white;
+    }
+  </style>
+{% endblock %}
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,6 +28,9 @@
     "sphinx_autodoc_typehints",
 ]
 
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
 autodoc_mock_imports = [
     "ert",
     "ert_shared",
@@ -73,61 +76,11 @@
 
 html_theme = "sphinx_rtd_theme"
 
-html_theme_options = {
-    "style_nav_header_background": "#C0C0C0",
-}
-
-
-# html_logo = "images/xtgeo-logo.png"
-
-# The name of an image file (within the static path) to use as favicon
-# of the docs.  This file should be a Windows icon file (.ico) being
-# 16x16 or 32x32 pixels large.
-# html_favicon = None
-
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page
-# bottom, using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names
-# to template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_domain_indices = True
-
-# If false, no index is generated.
-# html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer.
-# Default is True.
-# html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer.
-# Default is True.
-# html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages
-# will contain a <link> tag referring to it.  The value of this option
-# must be the base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
+# html_theme_options = {
+#     "style_nav_header_background": "#C0C0C0",
+# }
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = "fmu-sumo"
+
+html_logo = "_static/equinor-logo2.jpg"