otcdocstheme 1.12.1__tar.gz → 1.12.2__tar.gz

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/ChangeLog

@@ -1,6 +1,16 @@
 CHANGES
 =======
 
+1.12.2
+------
+
+* change margin bottom behavior (#299)
+
+1.12.0
+------
+
+* Automate Header with new Metadata (#295)
+
 1.12.1
 ------
 

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otcdocstheme
-Version: 1.12.1
+Version: 1.12.2
 Summary: OpenTelekomCloud Docs Theme
 Home-page: https://cloud.otc.com
 Author: Artem Goncharov
@@ -23,6 +23,7 @@ License-File: LICENSE
 Requires-Dist: pbr!=2.1.0,>=2.0.0
 Requires-Dist: dulwich>=0.15.0
 Requires-Dist: setuptools
+Requires-Dist: otc-metadata
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/doc/requirements.txt

@@ -7,3 +7,4 @@
 otc-api-ref>=0.1.0 # Apache-2.0
 reno>=3.1.0 # Apache-2.0
 gitpython
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata-rework.git#egg=otc-metadata

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/doc/source/conf.py

@@ -25,7 +25,7 @@ otcdocs_doc_type = 'umn'
 otcdocs_service_title = 'otcdocstheme (ecs Type)'
 otcdocs_service_type = 'ecs'
 otcdocs_service_category = 'theme'
-
+# otcdocs_cloud_environment = 'eu_de'
 otcdocs_search_environment = 'hc_de'
 otcdocs_search_url = 'https://opensearch.eco.tsi-dev.otc-service.com/'
 otcdocs_search_index = 'search_index_de'

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/otcdocstheme/ext.py

@@ -28,6 +28,9 @@ import textwrap
 from . import version
 from otcdocstheme import paths
 
+import otc_metadata.services
+METADATA = otc_metadata.services.Services()
+
 _series = None
 _project = None
 _giturl_source = {
@@ -161,6 +164,8 @@ def _html_page_context(app, pagename, templatename, context, doctree):
         otcdocs_search_environment = app.config.otcdocs_search_environment
         otcdocs_search_index = app.config.otcdocs_search_index
         otcdocs_search_url = app.config.otcdocs_search_url
+        otcdocs_cloud_environment = app.config.otcdocs_cloud_environment
+        otcdocs_environment = app.config.otcdocs_doc_environment
         current_commit_hash = app.config.current_commit_hash
         current_commit_time = app.config.current_commit_time
         _html_context_data['repository_name'] = repo_name
@@ -188,6 +193,96 @@ def _html_page_context(app, pagename, templatename, context, doctree):
         _html_context_data['current_commit_time'] = (
             current_commit_time
         )
+
+        # Header automation
+        if otcdocs_environment == "internal":
+            otcdocs_environment = ["public", "internal"]
+        else:
+            otcdocs_environment = ["public"]
+        otcdocs_categories_with_services = (
+            METADATA.all_services_by_categories(
+                cloud_environment=otcdocs_cloud_environment,
+                environments=otcdocs_environment
+            )
+        )
+        otcdocs_large_categories = [
+            {
+                "name": "IaaS",
+                "categories": [
+                     {
+                         "name": "compute",
+                         "services": []
+                     },
+                     {
+                         "name": "network",
+                         "services": []
+                     },
+                     {
+                         "name": "storage",
+                         "services": []
+                     }
+                ]
+            },
+            {
+                "name": "PaaS",
+                "categories": [
+                     {
+                         "name": "application",
+                         "services": []
+                     },
+                     {
+                         "name": "big_data",
+                         "services": []
+                     },
+                     {
+                         "name": "container",
+                         "services": []
+                     },
+                     {
+                         "name": "database",
+                         "services": []
+                     }
+                ]
+            },
+            {
+                "name": "Management",
+                "categories": [
+                     {
+                         "name": "md",
+                         "services": []
+                     }
+                ]
+            },
+            {
+                "name": "Security",
+                "categories": [
+                     {
+                         "name": "security-services",
+                         "services": []
+                     }
+                ]
+            },
+            {
+                "name": "Other",
+                "categories": [
+                     {
+                         "name": "other",
+                         "services": []
+                     }
+                ]
+            }
+        ]
+        for category in otcdocs_categories_with_services:
+            for i, custom_category in enumerate(otcdocs_large_categories):
+                for j, subcategory in enumerate(custom_category["categories"]):
+                    if category["name"] == subcategory["name"]:
+                        otcdocs_large_categories[i]["categories"][j]["services"] = category["services"]
+                        otcdocs_large_categories[i]["categories"][j]["title"] = category["title"]
+
+        _html_context_data['otcdocs_large_categories'] = (
+            otcdocs_large_categories
+        )
+
         logger.debug('[otcdocstheme] repository_name %r', repo_name)
         if repo_name and doc_path and git_fqdn:
             _source_url = app.config.otcdocs_source_url
@@ -561,6 +656,9 @@ def setup(app):
     app.add_config_value('current_commit_hash', '', 'env')
     app.add_config_value('current_commit_time', '', 'env')
 
+    # Header automation
+    app.add_config_value('otcdocs_cloud_environment', 'eu_de', 'env')
+
     app.set_translator('html', OTCHTML5Translator)
 
     # themes

otcdocstheme-1.12.2/otcdocstheme/theme/otcdocs/header.html

@@ -0,0 +1,155 @@
+{% if page_source_suffix %}{# an input file was read #}
+<!-- SOURCE_FILE: {% if giturl %}{{giturl}}/{% endif %}{{pagename}}{{page_source_suffix}} -->
+{% else %}{# a template was rendered directly #}
+<!-- TEMPLATE_NAME: {{pagename}} -->
+{% endif %}
+<button onclick="to_top()" id="scroll-to-top" class="to-top to-top-fixed" title="Go to top"
+  aria-label="Scroll to top"><i class="fa-solid fa-angle-up"></i></button>
+<!-- <div class="skippy sticky-top"></div> -->
+{% set base_url = theme_logo_url %}
+
+{% if otcdocs_search_environment == 'hc_swiss' %}
+    <scale-telekom-header app-name="Swiss Open Telekom Cloud Docs" logo-href="{{base_url}}">
+{% else %}
+    <scale-telekom-header app-name="Open Telekom Cloud Docs" logo-href="{{base_url}}">
+{% endif %}
+
+  <!--  meta-nav-aria-label="Meta navigation section" -->
+  <!--  meta-nav-external-aria-label="External navigation section"-->
+  <!--  lang-switcher-aria-label="Language switcher section"-->
+  <!--  main-nav-aria-label="Main navigation"-->
+  section>
+  <!-- main nav (desktop) -->
+  <scale-telekom-nav-list variant="main-nav" slot="main-nav">
+    {% for large_category in otcdocs_large_categories %}
+      <scale-telekom-nav-item>
+        <button>{{large_category.name}}</button>
+        <scale-telekom-nav-flyout hover>
+          <scale-telekom-mega-menu>
+            {% for category in large_category.categories %}
+            <scale-telekom-mega-menu-column>
+              <a href="{{base_url}}/{{category.name}}" slot="heading" target="_blank" rel="noopener noreferrer">{{category.title}}</a>
+              <ul>
+              {% for service in category.services %}
+                <li><a href="{{base_url}}/{{service.service_uri}}" target="_blank" rel="noopener noreferrer">{{service.service_title}}</a></li>
+              {%- endfor %}
+              </ul>
+            </scale-telekom-mega-menu-column>
+            {%- endfor %}
+          </scale-telekom-mega-menu>
+        </scale-telekom-nav-flyout>
+      </scale-telekom-nav-item>
+      {%- endfor %}
+    <scale-telekom-nav-item>
+      <button>Developers</button>
+      <scale-telekom-nav-flyout hover>
+        <scale-telekom-mega-menu>
+          <scale-telekom-mega-menu-column>
+            <a href="{{base_url}}/developer/api.html" target="_blank" rel="noopener noreferrer" slot="heading">APIs</a>
+            <ul>
+              <li><a href="{{base_url}}/developer/api.html" target="_blank" rel="noopener noreferrer">REST API</a></li>
+              <li><a href="{{base_url}}/developer/api_guidelines/index.html" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a></li>
+                <li><a href="{{base_url}}/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Endpoints</a></li>
+            </ul>
+          </scale-telekom-mega-menu-column>
+          <scale-telekom-mega-menu-column>
+            <a href="{{base_url}}/developer/index.html" target="_blank" rel="noopener noreferrer" slot="heading">Development and Automation</a>
+            <ul>
+              <li><a href="{{base_url}}/developer/sdk.html" target="_blank" rel="noopener noreferrer">SDKs</a></li>
+              <li><a href="{{base_url}}/developer/drivers.html" target="_blank" rel="noopener noreferrer">Drivers and Tools</a></li>
+              <li><a href="https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest/docs" target="_blank" rel="noopener noreferrer">Terraform</a></li>
+              <li><a href="{{base_url}}/ansible-collection-cloud/" target="_blank" rel="noopener noreferrer">Ansible</a></li>
+              <li><a href="{{base_url}}/cloud-create/" target="_blank" rel="noopener noreferrer">Cloud Create</a></li>
+            </ul>
+          </scale-telekom-mega-menu-column>
+          {% if not otcdocs_search_environment == 'hc_swiss' %}
+          <scale-telekom-mega-menu-column>
+            <a href="https://arch.otc-service.com/" target="_blank" rel="noopener noreferrer" slot="heading">Architecture Center</a>
+            <ul>
+              <li><a href="https://arch.otc-service.com/docs/best-practices/" target="_blank" rel="noopener noreferrer">Best Practices</a></li>
+              <li><a href="https://arch.otc-service.com/docs/blueprints/" target="_blank" rel="noopener noreferrer">Blueprints</a></li>
+            </ul>
+          </scale-telekom-mega-menu-column>
+          {% endif %}
+        </scale-telekom-mega-menu>
+      </scale-telekom-nav-flyout>
+    </scale-telekom-nav-item>
+  </scale-telekom-nav-list>
+  <scale-telekom-nav-list variant="functions" slot="functions" alignment="right">
+    <scale-telekom-nav-item>
+      <a id="SearchIconScaleNavBar" onclick="createSearchPage()">
+        <scale-icon-action-search accessibility-title="Search" />
+      </a>
+    </scale-telekom-nav-item>
+    <scale-telekom-nav-item>
+      {% if otcdocs_search_environment == 'hc_swiss' %}
+      <a href="https://console.sc.otc.t-systems.com/">
+      {% else %}
+      <a href="https://console.otc.t-systems.com/">
+          {% endif %}
+          <scale-badge no-dot label="Console">
+            <scale-icon-device-computer accessibility-title="console" />
+          </scale-badge>
+        </a>
+    </scale-telekom-nav-item>
+    <scale-telekom-nav-item>
+      <a href="https://community.open-telekom-cloud.com/">
+        <scale-badge no-dot label="Community">
+          <scale-icon-communication-chat accessibility-title="community" />
+        </scale-badge>
+      </a>
+    </scale-telekom-nav-item>
+    <scale-telekom-nav-item class="burger-item nodisplay-mobile">
+      <button>
+        <scale-icon-action-menu></scale-icon-action-menu>
+      </button>
+      <scale-telekom-nav-flyout class="mobile-nav-flyout">
+        <scale-telekom-mobile-flyout-canvas>
+            <!-- main-nav (mobile) -->
+            <scale-telekom-mobile-menu slot="mobile-main-nav">
+              {% for large_category in otcdocs_large_categories %}
+                <scale-telekom-mobile-menu-item>
+                  <a href="#">{{large_category.name}}</a>
+                  {% for category in large_category.categories %}
+                    <scale-telekom-mobile-menu-item slot="children">
+                      <a href="{{base_url}}/{{category.name}}.html" target="_blank" rel="noopener noreferrer">{{category.title}}</a>
+                      {% for service in category.services %}
+                        <scale-telekom-mobile-menu-item slot="children">
+                          <a href="{{base_url}}/{{service.service_uri}}/index.html">{{service.service_title}}</a>
+                        </scale-telekom-mobile-menu-item>
+                      {%- endfor %}
+                    </scale-telekom-mobile-menu-item>
+                  {%- endfor %}
+                </scale-telekom-mobile-menu-item>
+              {%- endfor %}
+            </scale-telekom-mobile-menu>
+        </scale-telekom-mobile-flyout-canvas>
+      </scale-telekom-nav-flyout>
+    </scale-telekom-nav-item>
+  </scale-telekom-nav-list>
+</scale-telekom-header>
+
+<div class="scl-container">
+  <div class="scl-container-width">
+    <nav id="docs-subnavbar" class="docs-subnavbar" aria-label="Secondary navigation">
+      <button id="subnavbar-togglebutton" class="btn docs-sidebar-toggle d-md-none navbar-toggler collapsed"
+        type="button" data-bs-toggle="collapse" data-bs-target="#docs-sidebar-nav" aria-controls="docs-sidebar-nav"
+        aria-expanded="false" aria-label="Toggle navigation">
+        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" class="bi bi-expand invert-dark" fill="currentColor"
+          viewBox="0 0 16 16">
+          <title>Expand</title>
+          <path fill-rule="evenodd"
+            d="M1 8a.5.5 0 0 1 .5-.5h13a.5.5 0 0 1 0 1h-13A.5.5 0 0 1 1 8zM7.646.146a.5.5 0 0 1 .708 0l2 2a.5.5 0 0 1-.708.708L8.5 1.707V5.5a.5.5 0 0 1-1 0V1.707L6.354 2.854a.5.5 0 1 1-.708-.708l2-2zM8 10a.5.5 0 0 1 .5.5v3.793l1.146-1.147a.5.5 0 0 1 .708.708l-2 2a.5.5 0 0 1-.708 0l-2-2a.5.5 0 0 1 .708-.708L7.5 14.293V10.5A.5.5 0 0 1 8 10z">
+          </path>
+        </svg>
+        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" class="bi bi-collapse invert-dark" fill="currentColor"
+          viewBox="0 0 16 16">
+          <title>Collapse</title>
+          <path fill-rule="evenodd"
+            d="M1 8a.5.5 0 0 1 .5-.5h13a.5.5 0 0 1 0 1h-13A.5.5 0 0 1 1 8zm7-8a.5.5 0 0 1 .5.5v3.793l1.146-1.147a.5.5 0 0 1 .708.708l-2 2a.5.5 0 0 1-.708 0l-2-2a.5.5 0 1 1 .708-.708L7.5 4.293V.5A.5.5 0 0 1 8 0zm-.5 11.707l-1.146 1.147a.5.5 0 0 1-.708-.708l2-2a.5.5 0 0 1 .708 0l2 2a.5.5 0 0 1-.708.708L8.5 11.707V15.5a.5.5 0 0 1-1 0v-3.793z">
+          </path>
+        </svg>
+      </button>
+    </nav>
+  </div>
+</div>

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/otcdocstheme/theme/otcdocs/static/css/otcdocstheme.css

@@ -972,16 +972,13 @@ code.docutils.literal.notranslate {
   max-width: 75%;
 }
 
-#docs-main img {
-  margin-bottom: 2rem;
-}
-
 .icon-svg {
   margin-bottom: 0!important;
 }
 
 #docs-main figure {
   margin-top: 2rem;
+  margin-bottom: 2rem;
 }
 
 @media (max-width: 1200px){

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/otcdocstheme.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otcdocstheme
-Version: 1.12.1
+Version: 1.12.2
 Summary: OpenTelekomCloud Docs Theme
 Home-page: https://cloud.otc.com
 Author: Artem Goncharov
@@ -23,6 +23,7 @@ License-File: LICENSE
 Requires-Dist: pbr!=2.1.0,>=2.0.0
 Requires-Dist: dulwich>=0.15.0
 Requires-Dist: setuptools
+Requires-Dist: otc-metadata
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

otcdocstheme-1.12.2/otcdocstheme.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata-rework.git#egg=otc-metadata

otcdocstheme-1.12.2/otcdocstheme.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "dbca5c4", "is_release": false}

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/otcdocstheme.egg-info/requires.txt

@@ -1,3 +1,4 @@
 pbr!=2.1.0,>=2.0.0
 dulwich>=0.15.0
 setuptools
+otc-metadata

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/requirements.txt

@@ -5,3 +5,4 @@
 pbr!=2.1.0,>=2.0.0 # Apache-2.0
 dulwich>=0.15.0 # Apache-2.0
 setuptools
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata-rework.git#egg=otc-metadata

{otcdocstheme-1.12.1 → otcdocstheme-1.12.2}/tox.ini

@@ -106,3 +106,4 @@ commands =
 exclude=.venv,.git,.tox,dist,doc,api-ref,*lib/python*,*egg,tools
 show-source = True
 enable-extensions = H203,H106
+extend-ignore = E501