added company branding

doc/_static/css/custom.css

@@ -0,0 +1,39 @@
+body {
+    font-family: Arial, Helvetica, sans-serif;
+    max-width: none !important;
+}
+
+table.align-default {
+    margin-left: 0;
+    margin-right: 0;
+}
+
+div.admonition {
+    background-color: #f7f2f3;
+}
+
+p.admonition-title {
+    background-color: #93bdff;
+}
+
+.red {
+    color: red;
+}
+
+.green {
+    color: green;
+}
+
+/* Use available width for navigation content (read the docs theme). */
+.wy-nav-content {
+    max-width: none !important; /* No Limit */
+}
+
+object {
+    width: none !important;
+}
+.rst-content {
+    width: 100% !important;
+    padding: 20px !important;
+}
+

doc/conf.py

@@ -1,20 +1,22 @@
-# pylint: disable=all
-# Configuration file for the Sphinx documentation builder.
+"""Configuration file for the Sphinx documentation builder."""
+# The following pylint checks are disabled because they are relevant
+# for this configuration file:
+# pylint: disable=invalid-name
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import os.path
 import platform
 import subprocess
+
 git_version = subprocess.check_output(
     ['git', 'describe', 'HEAD', '--tags', '--always'])
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
 project = "gitWorkInstructions"
-copyright = "2024 - present, NewTec GmbH"
+copyright = "2024 - present, NewTec GmbH"  #pylint: disable=redefined-builtin
 author = "NewTec GmbH"
 release = git_version.decode()
 version = release  # Do not differenciate between release and version
@@ -24,12 +26,18 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
+    # https://sphinxthemes.com/extensions/sphinxcontrib-mermaid
     "sphinxcontrib.mermaid",   # Mermaid diagrams
+    # https://github.com/sphinx-contrib/plantuml
     "sphinxcontrib.plantuml",  # Plantuml diagrams
-    "myst_parser",             # MyST markdown parser
-    "sphinx_rtd_dark_mode",    # Dark mode
+    # https://sphinxthemes.com/extensions/sphinx-copybutton
     "sphinx_copybutton",       # Copy button
-    "sphinx_togglebutton"      # Toggle button
+    # https://sphinx-togglebutton.readthedocs.io/en/latest/
+    "sphinx_togglebutton",     # Toggle button
+    # https://www.sphinx-doc.org/en/master/usage/markdown.html
+    'myst_parser',             # MyST markdown parser
+    # https://sphinx-rtd-theme.readthedocs.io/en/stable/
+    'sphinx_rtd_theme',        # Read the Docs theme
 ]
 
 templates_path = ["_templates"]
@@ -44,20 +52,25 @@
 
 # HTML theme and static files
 html_theme = "sphinx_rtd_theme"
-html_last_updated_fmt = "%b %d, %Y"
 html_theme_options = {
-    'style_external_links': True
+    # Set the navigation header background color to NewTec black  #0C2C40
+    'style_nav_header_background': '#0C2C40',   
 }
 
+html_last_updated_fmt = "%b %d, %Y"
+
+# Copy favorite icon to static path.
+html_favicon = '../doc/images/favicon.ico'
+
+# Copy logo to static path.
+html_logo = '../doc/images/NewTec_Logo.png'
+
 html_static_path = ["_static"]
+#html_js_files = ['version_selector.js']
 html_css_files = [
-    "css/svg.css",
-    "css/width.css"
+    "custom.css"
 ]
 
-# HTML dark theme options
-default_dark_mode = True
-
 # Mermaid configuration
 mermaid_output_format = "svg"
 mermaid_cmd = os.path.join("node_modules", ".bin", "mmdc")

doc/index.rst

@@ -1,11 +1,18 @@
-NewTec Git Work Instructions
-=====================================
+.. figure:: images/NewTec_Logo_Slogan.png
+   :align: right
+   :figwidth: 400px
+
+Git Work Instructions
+=====================
 
 Git is not restrictive on how the project structure shall look like, or how each repository shall be configured, making it the responsibility of users that work together to agree on the conventions and structures to be used. Depending on the project complexity and team size, different rulesets ensure either light overhead and flexibility or a tight harness around each developer.
 
 This documentation is intended to introduce the overall branching strategy to be used in all NewTec projects, specifically those hosted in `GitHub <https://github.com/NewTec-GmbH>`_. It will serve as a starting point for new project members to get up to speed with the existing workflow and a reference manual for developers.
 
-
+.. figure:: images/Gitterkugel_grau.png
+   :align: right
+   :figwidth: 250px
+
 .. toctree::
    :caption: Git:
    :maxdepth: 2
@@ -14,7 +21,6 @@ This documentation is intended to introduce the overall branching strategy to be
    git/github.md
    git/templates.md
 
-
 .. toctree::
    :caption: Branches:
    :maxdepth: 2