Anpassungen des Layouts

* Einfügen der Revisionsinformationen aus der Versionsverwaltung
 * Entfernen der Sphinx Verweise
 * Einfügen des Changelogs

.gitignore

@@ -0,0 +1,3 @@
+*~
+build/*
+jkurunterschrift.png

source/0_einleitung/vorwort.rst

@@ -15,9 +15,10 @@ Der Vorstand der KVT Kurlbaum AG verpflichtet sich, das Managementsystem und die
 Dieses Handbuch und die mitgeltenden Anlagen haben Weisungscharakter und werden hiermit in Kraft gesetzt. Alle Mitarbeiter sind verpflichtet, ihre Tätigkeiten gemäß den Regelungen des Management-Systems auszuführen und werden ausdrücklich aufgefordert, sich am kontinuierlichen Verbesserungsprozess aktiv zu beteiligen.
 
 
-Osterholz-Scharmbeck, den 23.03.2023
+Osterholz-Scharmbeck, den |today|
 
+.. image:: ../../jkurunterschrift.*
+   :height: 100px
+   :width: 200px
 
-Jörg Kurlbaum
-
-Vorstand
+Jörg Kurlbaum (Vorstand)

source/_static/css/custom.css

@@ -0,0 +1,11 @@
+.wy-side-nav-search {
+  display: block;
+  width: 300px;
+  padding: .809em;
+  margin-bottom: .809em;
+  z-index: 200;
+  /* some comment */
+  background-color: lightgray;
+  text-align: center;
+  color: #fefefe;
+}

source/_templates/footer.html

@@ -0,0 +1,64 @@
+<footer>
+  {%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
+    {#- Translators: This is an ARIA section label for the footer section of the page. -#}
+    <div class="rst-footer-buttons" role="navigation" aria-label="{{ _('Footer') }}">
+      {%- if prev %}
+        <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
+      {%- endif %}
+      {%- if next %}
+        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+      {%- endif %}
+    </div>
+  {%- endif %}
+
+  <hr/>
+
+  <div role="contentinfo">
+  {%- block contentinfo %}
+    <p>
+    {%- if show_copyright %}
+      {%- if hasdoc('copyright') %}
+        {%- trans path=pathto('copyright'), copyright=copyright|e %}&#169; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+      {%- else %}
+        {%- trans copyright=copyright|e %}&#169; Copyright {{ copyright }}.{% endtrans %}
+      {%- endif %}
+    {%- endif %}
+
+    {%- if build_id and build_url %}
+      <span class="build">
+        {#- Translators: Build is a noun, not a verb -#}
+        {%- trans %}Build{% endtrans -%}
+        <a href="{{ build_url }}">{{ build_id }}</a>.
+      </span>
+    {%- elif commit %}
+      <span class="commit">
+        {#- Translators: the phrase "revision" comes from Git, referring to a commit #}
+        {%- trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
+      </span>
+    {%- endif %}
+    {%- if last_updated %}
+      <span class="lastupdated">
+        {%- trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+      </span>
+    {%- endif -%}
+
+    </p>
+  {%- endblock %}
+  </div>
+
+  {% if show_sphinx %}
+    {%- set sphinx_web = '<a href="https://www.sphinx-doc.org/">Sphinx</a>' %}
+    {%- set readthedocs_web = '<a href="https://readthedocs.org">Read the Docs</a>'  %}
+    {#- Translators: the variable "sphinx_web" is a link to the Sphinx project documentation with the text "Sphinx" #}
+    {%- trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %}
+    {#- Translators: "theme" refers to a theme for Sphinx, which alters the appearance of the generated documentation #}
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">{% trans %}theme{% endtrans %}</a>
+    {#- Translators: this is always used as "provided by Read the Docs", and should not imply Read the Docs is an author of the generated documentation. #}
+    {% trans %}provided by {{ readthedocs_web }}{% endtrans %}.
+  {% endif %}
+
+  Revision: {{ gitrevision }}
+
+  {%- block extrafooter %} {% endblock %}
+
+</footer>

source/conf.py

@@ -6,6 +6,8 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+import subprocess
+
 project = 'Qualitätsmanagement-Handbuch'
 copyright = '2023, Qualitätsmanagementbeauftragter (QMB)'
 author = 'Qualitätsmanagementbeauftragter (QMB)'
@@ -17,7 +19,7 @@ release = '2.0-alpha'
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.graphviz', 'sphinx.ext.todo', 'sphinx.ext.autosectionlabel', 'sphinx.ext.imgconverter']
+extensions = ['sphinx.ext.graphviz', 'sphinx.ext.todo', 'sphinx.ext.autosectionlabel', 'sphinx.ext.imgconverter', 'sphinx_git']
 todo_include_todos = True
 templates_path = ['_templates']
 exclude_patterns = []
@@ -25,8 +27,14 @@ exclude_patterns = []
 language = 'de'
 
 
+show_sphinx = False
+
 numfig = True
 
+gitrevision = subprocess.run('git rev-parse --short HEAD'.split(' '), capture_output=True).stdout.decode('UTF-8')
+gitlastauthor = subprocess.run('git log -1 --pretty=format:%an'.split(' '), capture_output=True).stdout.decode('UTF-8')
+
+
 rst_prolog = """
 .. |ISONORM| replace:: DIN EN ISO 9001:2015-11
 .. |KVT| replace:: KVT Kurlbaum AG
@@ -38,7 +46,9 @@ rst_prolog = """
 .. |AA| replace:: Arbeitsanweisung
 .. |SP| replace:: Spezifikation
 .. |Formular| replace:: Formblätter / Vorlagen
-"""
+.. |gitrevision| replace:: {}
+.. |gitauthor| replace:: {}
+""".format(gitrevision, gitlastauthor)
 
 rst_epilog = """
 
@@ -51,8 +61,32 @@ rst_epilog = """
 
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
+html_logo = 'kvt-logo.png'
+html_css_files = [
+    'css/custom.css',
+]
+html_context = {
+    'show_sphinx': False,
+    'gitrevision': gitrevision,
+    'gitauthor': gitlastauthor
+}
+html_theme_options = {
+    #'logo_only': True,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': False,
+    'vcs_pageview_mode': '',
+    #'style_nav_header_background': 'white',
+    # Toc options
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 2,
+    'includehidden': True,
+    'titles_only': False
+}
 
 
 
 # -- Options for Latex/PDF export
 latex_engine = 'xelatex'
+latex_theme = 'howto'

source/index.rst

@@ -6,6 +6,18 @@
 Qualitätsmanagement-Handbuch der KVT Kurlbaum AG
 ================================================
 
++-----------+-------------+
+|Revision   | |release|   |
++-----------+-------------+
+|Datum      ||today|      |
++-----------+-------------+
+|Commit     ||gitrevision||
++-----------+-------------+
+|Bearbeiter | |gitauthor| |
++-----------+-------------+
+|Reviewer   |???          |
++-----------+-------------+
+
 .. toctree::
    :maxdepth: 2
    :numbered:
@@ -24,6 +36,17 @@ Qualitätsmanagement-Handbuch der KVT Kurlbaum AG
    verbesserung/index
 
 
+Changelog
+=========
+
+.. git_changelog::
+
+
+.. git_commit_detail::
+    :branch:
+    :commit:
+
+
 TODO
 ====
 .. todolist::