Update tox.ini && conf.py file

Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>

api-ref/source/conf.py

@@ -16,6 +16,8 @@
 
 import os
 import sys
+from git import Repo
+from datetime import datetime
 
 extensions = [
     'otcdocstheme',
@@ -104,6 +106,7 @@ html_title = "Cloud Firewall - API Reference"
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+templates_path = ['_templates']
 
 # Do not include sources into the rendered results
 html_copy_source = False
@@ -115,3 +118,17 @@ latex_documents = [
      u'Cloud Firewall - API Reference',
      u'OpenTelekomCloud', 'manual'),
 ]
+
+# Get the Git commit values for last updated timestamp on each page
+repo = Repo(search_parent_directories=True)
+commit = repo.head.commit
+current_commit_hash = commit.hexsha
+current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')
+
+latex_elements = {
+  'papersize': 'a4paper',
+  'pointsize': '12pt',
+  'figure_align': 'H',
+  'preamble': r'\newcommand{\githash}{' + current_commit_hash + '}',
+  'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
+}

api-ref/source/docutils.conf

@@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top

api-ref/source/index.rst

@@ -1,3 +1,4 @@
-==============================================
-Welcome to the documentation of cloud-firewall
-==============================================
+==============================
+Cloud Firewall - API Reference
+==============================
+

doc/requirements.txt

@@ -9,3 +9,4 @@ otc-sphinx-directives>=0.1.0
 sphinx-minify>=0.0.1 # Apache-2.0
 git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
 setuptools
+gitpython

doc/source/conf.py

@@ -16,6 +16,8 @@
 
 import os
 import sys
+from git import Repo
+from datetime import datetime
 
 extensions = [
     'otcdocstheme',
@@ -105,9 +107,24 @@ html_title = "Cloud Firewall - Service Based View"
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+templates_path = ['_templates']
 
 # Do not include sources into the rendered results
 html_copy_source = False
 
 # -- Options for PDF output --------------------------------------------------
 latex_documents = []
+
+# Get the Git commit values for last updated timestamp on each page
+repo = Repo(search_parent_directories=True)
+commit = repo.head.commit
+current_commit_hash = commit.hexsha
+current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')
+
+latex_elements = {
+  'papersize': 'a4paper',
+  'pointsize': '12pt',
+  'figure_align': 'H',
+  'preamble': r'\newcommand{\githash}{' + current_commit_hash + '}',
+  'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
+}

doc/source/index.rst

@@ -1,8 +1,13 @@
 Cloud Firewall
 ==============
 
+Cloud Firewall (CFW) is a next-generation cloud-native firewall. It protects Internet and VPC borders on the cloud by real-time intrusion detection and prevention, global unified access control, full traffic analysis, log audit, and tracing. It employs AI for intelligent defense, and can be elastically scaled to meet changing business needs, helping you easily handle security threats. CFW is a basic service that provides network security protection for user services on the cloud.
+
 .. directive_wrapper::
    :class: container-sbv
 
    .. service_card::
       :service_type: cfw
+      :environment: internal
+      :umn: This document provides detailed operation guidance of CFW to help you learn and use CFW.
+      :api-ref: This document describes how to use application programming interfaces (APIs) to perform operations on CFW, such as querying and updating.

tox.ini

@@ -58,6 +58,10 @@ allowlist_externals =
 commands =
   mkdir -p doc/build/pdf
   {[testenv:bindeps]commands}
+  mkdir -p {toxinidir}/_templates
+  wget -O {toxinidir}/_templates/longtable.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/longtable.tex.jinja
+  wget -O {toxinidir}/_templates/tabular.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabular.tex.jinja
+  wget -O {toxinidir}/_templates/tabulary.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabulary.tex.jinja
   {[testenv:umn-pdf-docs]commands}
   {[testenv:api-ref-pdf-docs]commands}
 
@@ -100,6 +104,7 @@ allowlist_externals =
   cp
 commands =
   rm -rf umn/build/pdf
+  cp -r {toxinidir}/_templates umn/source/_templates/
   sphinx-build -W --keep-going -b latex umn/source umn/build/pdf/
   bash -c "for f in umn/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
   bash -c "for f in umn/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
@@ -146,6 +151,7 @@ allowlist_externals =
   cp
 commands =
   rm -rf api-ref/build/pdf
+  cp -r {toxinidir}/_templates api-ref/source/_templates/
   sphinx-build -W --keep-going -b latex api-ref/source api-ref/build/pdf/
   bash -c "for f in api-ref/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
   bash -c "for f in api-ref/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"

umn/source/conf.py

@@ -16,6 +16,8 @@
 
 import os
 import sys
+from git import Repo
+from datetime import datetime
 
 extensions = [
     'otcdocstheme',
@@ -104,6 +106,7 @@ html_title = "Cloud Firewall - User Guide"
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+templates_path = ['_templates']
 
 # Do not include sources into the rendered results
 html_copy_source = False
@@ -115,3 +118,17 @@ latex_documents = [
      u'Cloud Firewall - User Guide',
      u'OpenTelekomCloud', 'manual'),
 ]
+
+# Get the Git commit values for last updated timestamp on each page
+repo = Repo(search_parent_directories=True)
+commit = repo.head.commit
+current_commit_hash = commit.hexsha
+current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')
+
+latex_elements = {
+  'papersize': 'a4paper',
+  'pointsize': '12pt',
+  'figure_align': 'H',
+  'preamble': r'\newcommand{\githash}{' + current_commit_hash + '}',
+  'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
+}

umn/source/docutils.conf

@@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top

umn/source/index.rst

@@ -1,3 +1,4 @@
-==============================================
-Welcome to the documentation of cloud-firewall
-==============================================
+===========================
+Cloud Firewall - User Guide
+===========================
+

zuul.yaml

@@ -1,3 +1,4 @@
+---
 - project:
     merge-mode: squash-merge
     default-branch: main