Compare commits

..

9 Commits

Author SHA1 Message Date
3503ed414e enable asm for upcoming release on prod
All checks were successful
gl/check check status: success (3503ed414e5f0707d551fa47e7cb34532648f016)
gl/gate gate status: success (3503ed414e5f0707d551fa47e7cb34532648f016)
2024-09-25 12:46:08 +00:00
0681226873 removed extra tags
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-committed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
2024-09-19 14:05:51 +00:00
0ede9b724d fixing wrong reference to original doc location
Reviewed-by: vladimirvshivkov <vshivkovvladimir@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2024-09-19 11:05:16 +00:00
6884d80c33 remove-obsswiftapi-yaml
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-committed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
2024-09-19 08:02:22 +00:00
edaf38baf6 Create EPS api/umn documentation
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-09-17 13:27:32 +00:00
e153f7d112 longer commit string
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>
2024-09-06 08:04:20 +00:00
7ec0772602 Added Commit Hash and Time to confpy
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>
2024-09-06 07:35:42 +00:00
0cc28b7d0b Removing OBS Swift API from the public documentation
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-committed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
2024-09-02 13:33:06 +00:00
406302b448 adding rfs metadata
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2024-08-08 10:59:33 +00:00
20 changed files with 87 additions and 348 deletions

View File

@ -1,5 +1,5 @@
--- ---
environment: internal environment: public
hc_location: usermanual/asm hc_location: usermanual/asm
html_location: docs/asm/umn html_location: docs/asm/umn
link: /application-service-mesh/umn/ link: /application-service-mesh/umn/

View File

@ -1,5 +1,4 @@
--- ---
environment: internal
hc_location: api/rms hc_location: api/rms
html_location: docs/config/api-ref html_location: docs/config/api-ref
link: /config/api-ref/ link: /config/api-ref/

View File

@ -1,5 +1,4 @@
--- ---
environment: internal
hc_location: usermanual/rms hc_location: usermanual/rms
html_location: docs/config/umn html_location: docs/config/umn
link: /config/umn/ link: /config/umn/

View File

@ -0,0 +1,11 @@
---
environment: internal
hc_location: api/em
html_location: docs/eps/api-ref
link: /enterprise-project-service/api-ref/
pdf_name: eps-api-ref
rst_location: api-ref/source
service_type: eps
title: API Reference
type: api-ref

View File

@ -0,0 +1,11 @@
---
environment: internal
hc_location: usermanual/em
html_location: docs/eps/umn
link: /enterprise-project-service/umn/
pdf_name: eps-umn
rst_location: umn/source
service_type: eps
title: User Guide
type: umn

View File

@ -1,9 +0,0 @@
---
hc_location: api_swift/obs
html_location: docs/obs/api-swift
link: /object-storage-service/swiftapi/
pdf_name: obs-swiftapi
rst_location: doc/swiftapi/source
service_type: obs
title: API Reference (Swift) - Deprecated - Will be removed at 2023 Nov. 10!
type: swiftapi

View File

@ -0,0 +1,10 @@
---
hc_location: api/aos
environment: internal
html_location: docs/rfs/api-ref
link: /resource-formation-service/api-ref/
pdf_name: rfs-api-ref
rst_location: api-ref/source
service_type: rfs
title: API Reference
type: api-ref

View File

@ -0,0 +1,10 @@
---
hc_location: usermanual/aos
environment: internal
html_location: docs/rfs/umn
link: /resource-formation-service/umn/
pdf_name: rfs-umn
rst_location: umn/source
service_type: rfs
title: User Guide
type: umn

View File

@ -1,5 +1,5 @@
--- ---
environment: internal environment: public
repositories: repositories:
- environment: internal - environment: internal
repo: docs/application-service-mesh repo: docs/application-service-mesh

View File

@ -1,5 +1,5 @@
--- ---
environment: internal environment: public
repositories: repositories:
- environment: internal - environment: internal
repo: docs/config repo: docs/config

View File

@ -0,0 +1,17 @@
---
environment: internal
repositories:
- environment: internal
repo: docs/enterprise-project-service
type: gitea
- environment: public
repo: opentelekomcloud-docs/enterprise-project-service
type: github
service_category: security-services
service_title: Enterprise Project Service
service_type: eps
service_uri: enterprise-project-service
teams:
- name: docs-security-services-rw
permission: write

View File

@ -0,0 +1,16 @@
---
environment: internal
repositories:
- environment: internal
repo: docs/resource-formation-service
type: gitea
- environment: public
repo: opentelekomcloud-docs/resource-formation-service
type: github
service_category: application
service_title: Resource Formation Service
service_type: rfs
service_uri: resource-formation-service
teams:
- name: docs-orchestration-rw
permission: write

View File

@ -16,6 +16,8 @@
import os import os
import sys import sys
from git import Repo
from datetime import datetime
extensions = [ extensions = [
'otcdocstheme', 'otcdocstheme',
@ -131,5 +133,8 @@ latex_documents = [
{% endif -%} {% endif -%}
] ]
# Path for the latex templates # Get the Git commit values for last updated timestamp on each page
templates_path = ['_templates'] 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

@ -12,4 +12,5 @@ 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 sphinx-minify>=0.0.1 # Apache-2.0
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
setuptools setuptools
gitpython

File diff suppressed because it is too large Load Diff

View File

@ -1,74 +0,0 @@
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
<% if 'booktabs' in table.styles -%>
\sphinxthistablewithbooktabsstyle
<% endif -%>
<% if 'borderless' in table.styles -%>
\sphinxthistablewithborderlessstyle
<% endif -%>
<% if 'standard' in table.styles -%>
\sphinxthistablewithstandardstyle
<% endif -%>
<% if 'vlines' in table.styles -%>
\sphinxthistablewithvlinesstyle
<% endif -%>
<% if 'novlines' in table.styles -%>
\sphinxthistablewithnovlinesstyle
<% endif -%>
<% if 'colorrows' in table.styles -%>
\sphinxthistablewithcolorrowsstyle
<% endif -%>
<% if 'nocolorrows' in table.styles -%>
\sphinxthistablewithnocolorrowsstyle
<% endif -%>
\makeatletter
<%- if table.align in ('center', 'default') %>
\LTleft \@totalleftmargin plus1fill
\LTright\dimexpr\columnwidth-\@totalleftmargin-\linewidth\relax plus1fill
<%- elif table.align == 'left' %>
\LTleft \@totalleftmargin
\LTright\dimexpr\columnwidth-\@totalleftmargin-\linewidth\relax plus1fill
<%- elif table.align == 'right' %>
\LTleft \@totalleftmargin plus1fill
\LTright\dimexpr\columnwidth-\@totalleftmargin-\linewidth\relax
<%- endif %>
\makeatother
\begin{longtable}<%= table.get_colspec() %>
<%- if table.caption -%>
\sphinxthelongtablecaptionisattop
\caption{<%= ''.join(table.caption) %>\strut}<%= labels %>\\*[\sphinxlongtablecapskipadjust]
<% elif labels -%>
\noalign{\phantomsection<%= labels %>}%
<% endif -%>
\sphinxtoprule
<%= ''.join(table.header) -%>
<%- if table.header -%>
\sphinxmidrule
<% endif -%>
\endfirsthead
\multicolumn{<%= table.colcount %>}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} <%= _('continued from previous page') %>}}%
}\\
\sphinxtoprule
<%= ''.join(table.header) -%>
<%- if table.header -%>
\sphinxmidrule
<% endif -%>
\endhead
\sphinxbottomrule
\multicolumn{<%= table.colcount %>}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{<%= _('continues on next page') %>}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
<%= ''.join(table.body) -%>
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@ -1,21 +0,0 @@
%
% sphinxmessages.sty
%
% message resources for Sphinx
%
\ProvidesPackage{sphinxmessages}[2019/01/04 v2.0 Localized LaTeX macros (Sphinx team)]
\renewcommand{\literalblockcontinuedname}{<%= _('continued from previous page') | e %>}
\renewcommand{\literalblockcontinuesname}{<%= _('continues on next page') | e %>}
\renewcommand{\sphinxnonalphabeticalgroupname}{<%= _('Non-alphabetical') | e %>}
\renewcommand{\sphinxsymbolsname}{<%= _('Symbols') | e %>}
\renewcommand{\sphinxnumbersname}{<%= _('Numbers') | e %>}
\def\pageautorefname{<%= _('page') | e %>}
<%= addtocaptions %>{\renewcommand{\figurename}{<%= figurename[0] | e | eabbr %>}}
\def\fnum@figure{\figurename\thefigure{}<%= figurename[1] | e %>}
<%= addtocaptions %>{\renewcommand{\tablename}{<%= tablename[0] | e | eabbr %>}}
\def\fnum@table{\tablename\thetable{}<%= tablename[1] | e %>}
<%= addtocaptions %>{\renewcommand{\literalblockname}{<%= literalblockname[0].strip() %>}}

View File

@ -1,54 +0,0 @@
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
<% if 'booktabs' in table.styles -%>
\sphinxthistablewithbooktabsstyle
<% endif -%>
<% if 'borderless' in table.styles -%>
\sphinxthistablewithborderlessstyle
<% endif -%>
<% if 'standard' in table.styles -%>
\sphinxthistablewithstandardstyle
<% endif -%>
<% if 'vlines' in table.styles -%>
\sphinxthistablewithvlinesstyle
<% endif -%>
<% if 'novlines' in table.styles -%>
\sphinxthistablewithnovlinesstyle
<% endif -%>
<% if 'colorrows' in table.styles -%>
\sphinxthistablewithcolorrowsstyle
<% endif -%>
<% if 'nocolorrows' in table.styles -%>
\sphinxthistablewithnocolorrowsstyle
<% endif -%>
<% if table.align -%>
<%- if table.align in ('center', 'default') -%>
\centering
<%- elif table.align == 'left' -%>
\raggedright
<%- else -%>
\raggedleft
<%- endif %>
<%- else -%>
\centering
<%- endif %>
<% if table.caption -%>
\sphinxcapstartof{table}
\sphinxthecaptionisattop
\sphinxcaption{<%= ''.join(table.caption) %>}<%= labels %>
\sphinxaftertopcaption
<% elif labels -%>
\phantomsection<%= labels %>\nobreak
<% endif -%>
\begin{tabular}[t]<%= table.get_colspec() -%>
\sphinxtoprule
<%= ''.join(table.header) -%>
<%- if table.header -%>
\sphinxmidrule
<% endif -%>
\sphinxtableatstartofbodyhook
<%=- ''.join(table.body) -%>
\sphinxbottomrule
\end{tabular}
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@ -1,54 +0,0 @@
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
<% if 'booktabs' in table.styles -%>
\sphinxthistablewithbooktabsstyle
<% endif -%>
<% if 'borderless' in table.styles -%>
\sphinxthistablewithborderlessstyle
<% endif -%>
<% if 'standard' in table.styles -%>
\sphinxthistablewithstandardstyle
<% endif -%>
<% if 'vlines' in table.styles -%>
\sphinxthistablewithvlinesstyle
<% endif -%>
<% if 'novlines' in table.styles -%>
\sphinxthistablewithnovlinesstyle
<% endif -%>
<% if 'colorrows' in table.styles -%>
\sphinxthistablewithcolorrowsstyle
<% endif -%>
<% if 'nocolorrows' in table.styles -%>
\sphinxthistablewithnocolorrowsstyle
<% endif -%>
<% if table.align -%>
<%- if table.align in ('center', 'default') -%>
\centering
<%- elif table.align == 'left' -%>
\raggedright
<%- else -%>
\raggedleft
<%- endif %>
<%- else -%>
\centering
<%- endif %>
<% if table.caption -%>
\sphinxcapstartof{table}
\sphinxthecaptionisattop
\sphinxcaption{<%= ''.join(table.caption) %>}<%= labels %>
\sphinxaftertopcaption
<% elif labels -%>
\phantomsection<%= labels %>\nobreak
<% endif -%>
\begin{tabulary}{\linewidth}[t]<%= table.get_colspec() -%>
\sphinxtoprule
<%= ''.join(table.header) -%>
<%- if table.header -%>
\sphinxmidrule
<% endif -%>
\sphinxtableatstartofbodyhook
<%=- ''.join(table.body) -%>
\sphinxbottomrule
\end{tabulary}
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@ -15,10 +15,8 @@
import argparse import argparse
import logging import logging
import os.path
import pathlib import pathlib
import requests import requests
import shutil
import subprocess import subprocess
from git import exc from git import exc
@ -50,7 +48,6 @@ def process_repositories(args, service):
env = Environment( env = Environment(
loader=PackageLoader("otc_metadata"), autoescape=select_autoescape() loader=PackageLoader("otc_metadata"), autoescape=select_autoescape()
) )
metadata_path = os.path.dirname(os.path.abspath(os.path.dirname(__file__)))
conf_py_template = env.get_template("conf.py.j2") conf_py_template = env.get_template("conf.py.j2")
tox_ini_template = env.get_template("tox.ini.j2") tox_ini_template = env.get_template("tox.ini.j2")
zuul_yaml_template = env.get_template("zuul.yaml.j2") zuul_yaml_template = env.get_template("zuul.yaml.j2")
@ -133,23 +130,6 @@ def process_repositories(args, service):
logging.debug(f"Analyzing document {doc}") logging.debug(f"Analyzing document {doc}")
conf_py_path = pathlib.Path(copy_to, doc["rst_location"], "conf.py") conf_py_path = pathlib.Path(copy_to, doc["rst_location"], "conf.py")
latex_templates_src_path = pathlib.Path(metadata_path, "otc_metadata", "templates", "latex_templates")
latex_templates_dest_path = pathlib.Path(copy_to, doc["rst_location"], "_templates")
# Check if the latex destination path exists and is a directory
if not latex_templates_dest_path.exists():
logging.info(f"Path for latex templates in {doc['title']} does not exist")
latex_templates_dest_path.mkdir(parents=True, exist_ok=True)
# Delete all files in the latex destination directory
for file in latex_templates_dest_path.iterdir():
if file.is_file():
file.unlink()
# Add the new templates
for file in latex_templates_src_path.iterdir():
shutil.copy2(file, latex_templates_dest_path)
if not conf_py_path.exists(): if not conf_py_path.exists():
logging.info(f"Path for document {doc['title']} does not exist") logging.info(f"Path for document {doc['title']} does not exist")
conf_py_path.parent.mkdir(parents=True, exist_ok=True) conf_py_path.parent.mkdir(parents=True, exist_ok=True)