Compare commits

..

1 Commits

Author SHA1 Message Date
d3e03e87fe fixing various different issues
All checks were successful
gl/check check status: success (d3e03e87feb3e7c732bb94199716ca08f62abe3d)
gl/gate gate status: success (d3e03e87feb3e7c732bb94199716ca08f62abe3d)
2023-08-16 11:26:57 +00:00
12 changed files with 23 additions and 164 deletions

3
.gitignore vendored
View File

@ -59,6 +59,3 @@ ChangeLog
# Files created by releasenotes build # Files created by releasenotes build
releasenotes/build releasenotes/build
bindep.txt
packages.txt

View File

@ -1,10 +0,0 @@
---
environment: internal
hc_location: api/lts
html_location: docs/lts/api-ref
link: /log-tank-service/api-ref/
pdf_name: lts-api-ref
rst_location: api-ref/source
service_type: lts
title: API Reference
type: api-ref

View File

@ -1,10 +0,0 @@
---
environment: internal
hc_location: usermanual/lts
html_location: docs/lts/umn
link: /log-tank-service/umn/
pdf_name: lts-umn
rst_location: umn/source
service_type: lts
title: User Guide
type: umn

View File

@ -1,3 +1,3 @@
--- ---
name: database name: database
title: Databases title: Database

View File

@ -1,16 +0,0 @@
---
environment: internal
repositories:
- environment: internal
repo: docs-swiss/log-tank-service
type: gitea
- environment: public
repo: opentelekomcloud-docs-swiss/log-tank-service
type: github
service_category: md
service_title: Log Tank Service
service_type: lts
service_uri: log-tank-service
teams:
- name: docs-orchestration-rw
permission: write

View File

@ -87,13 +87,10 @@ class Services(object):
res.append(copy.deepcopy(cat)) res.append(copy.deepcopy(cat))
return res return res
def services_by_category(self, category, environment=None): def services_by_category(self, category):
"""List services matching category""" """List services matching category"""
res = [] res = []
for srv in self.all_services: for srv in self.all_services:
if environment:
if "environment" in srv and srv["environment"] != environment:
continue
if srv["service_category"] == category: if srv["service_category"] == category:
res.append(copy.deepcopy(srv)) res.append(copy.deepcopy(srv))
return res return res

View File

@ -16,8 +16,6 @@
import os import os
import sys import sys
from git import Repo
from datetime import datetime
extensions = [ extensions = [
'otcdocstheme', 'otcdocstheme',
@ -48,7 +46,6 @@ otcdocs_service_category = '{{ service_category }}'
otcdocs_service_title = '{{ service_title }}' otcdocs_service_title = '{{ service_title }}'
otcdocs_service_type = '{{ service_type }}' otcdocs_service_type = '{{ service_type }}'
otcdocs_search_environment = 'hc_swiss' otcdocs_search_environment = 'hc_swiss'
otcdocs_search_index = 'search_index_swiss'
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/" otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
@ -134,8 +131,3 @@ latex_documents = [
{% endif -%} {% endif -%}
] ]
# 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')

View File

@ -1,16 +1,7 @@
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
{% if target_environment == 'public' %}
otcdocstheme<2.0.0 # Apache-2.0
{% elif target_environment == 'internal' %}
otcdocstheme # Apache-2.0 otcdocstheme # Apache-2.0
{% else %}
otcdocstheme # Apache-2.0
{% endif %}
# releasenotes # releasenotes
reno>=3.1.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
otc-sphinx-directives>=0.1.0 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-swiss.git#egg=otc_metadata git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata-swiss.git#egg=otc_metadata
setuptools
gitpython

View File

@ -5,4 +5,3 @@
.. service_card:: .. service_card::
:service_type: {{ service_type }} :service_type: {{ service_type }}
:environment: {{ environment }}

View File

@ -34,28 +34,23 @@ allowlist_externals =
rm rm
sphinx-build sphinx-build
commands = commands =
rm -rf doc/build/html doc/build/html_temp doc/build/doctrees rm -rf doc/build/html doc/build/doctrees
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
{%- for doc in docs %} {%- for doc in docs %}
{[testenv:{{ doc.type }}]commands} {[testenv:{{ doc.type }}]commands}
{[testenv:json-{{ doc.type }}]commands} {[testenv:json-{{ doc.type }}]commands}
{%- endfor %} {%- endfor %}
[testenv:docs-pdf] [testenv:docs-pdf]
deps = deps = {[testenv:docs]deps}
{[testenv:docs]deps}
{[testenv:bindeps]deps}
allowlist_externals = allowlist_externals =
rm rm
mkdir mkdir
wget
make make
bash bash
cp cp
commands = commands =
mkdir -p doc/build/pdf mkdir -p doc/build/pdf
{[testenv:bindeps]commands}
{%- for doc in docs %} {%- for doc in docs %}
{%- if doc.pdf_name %} {%- if doc.pdf_name %}
{[testenv:{{ doc.type }}-pdf-docs]commands} {[testenv:{{ doc.type }}-pdf-docs]commands}
@ -71,14 +66,16 @@ allowlist_externals =
cp cp
mkdir mkdir
commands = commands =
sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html_temp/{{ doc.type }} sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html/{{ doc.type }}
sphinx-minify --input-directory doc/build/html_temp/{{ doc.type }} --output-directory doc/build/html/{{ doc.type }} {%- if doc.type == 'api-ref' %}
{%- if doc.type == 'dev-guide' %} mkdir -p api-ref/build/html
cp -av doc/build/html/api-ref api-ref/build/html
{%- elif doc.type == 'umn' %}
mkdir -p umn/build/html
cp -av doc/build/html/umn umn/build/html
{%- elif doc.type == 'dev-guide' %}
mkdir -p dev_guide/build/html mkdir -p dev_guide/build/html
cp -av doc/build/html/dev-guide dev_guide/build/html cp -av doc/build/html/dev-guide dev_guide/build/html
{%- else %}
mkdir -p {{ doc.type }}/build/html
cp -av doc/build/html/{{ doc.type }} {{ doc.type }}/build/html
{%- endif %} {%- endif %}
# Json version (for search) # Json version (for search)
@ -93,12 +90,15 @@ commands =
# Drop data useless for the search - wrap it also with sh/xargs due to bugs # Drop data useless for the search - wrap it also with sh/xargs due to bugs
# in tox # in tox
sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf" sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
{%- if doc.type == 'dev-guide' %} {%- if doc.type == 'api-ref' %}
mkdir -p api-ref/build/json
cp -av doc/build/json/api-ref api-ref/build/json
{%- elif doc.type == 'umn' %}
mkdir -p umn/build/json
cp -av doc/build/json/umn umn/build/json
{%- elif doc.type == 'dev-guide' %}
mkdir -p dev_guide/build/json mkdir -p dev_guide/build/json
cp -av doc/build/json/dev-guide dev_guide/build/json cp -av doc/build/json/dev-guide dev_guide/build/json
{%- else %}
mkdir -p {{ doc.type }}/build/json
cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
{%- endif %} {%- endif %}
{% if doc.pdf_name -%} {% if doc.pdf_name -%}
@ -122,21 +122,6 @@ commands =
{% endif %} {% endif %}
{% endfor %} {% endfor %}
[testenv:bindeps]
deps =
bindep
allowlist_externals =
wget
rm
bash
commands =
rm -rf {toxinidir}/bindep.txt
rm -rf {toxinidir}/packages.txt
wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
[doc8] [doc8]
ignore = D001 ignore = D001
extensions = .rst, .yaml extensions = .rst, .yaml

View File

@ -1,12 +0,0 @@
---
- project:
merge-mode: squash-merge
default-branch: main
templates:
- helpcenter-swiss-base-jobs
check:
jobs:
- noop
gate:
jobs:
- noop

File diff suppressed because it is too large Load Diff