otcdocstheme 1.8.2__tar.gz → 1.9.1__tar.gz

{otcdocstheme-1.8.2 → otcdocstheme-1.9.1}/ChangeLog

@@ -1,6 +1,17 @@
 CHANGES
 =======
 
+1.9.1
+-----
+
+* Update PDF startpage (#270)
+
+1.9.0
+-----
+
+* PDF with table templates (#255)
+* Switch internal tracking to Umami (#269)
+
 1.8.2
 -----
 

{otcdocstheme-1.8.2/otcdocstheme.egg-info → otcdocstheme-1.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: otcdocstheme
-Version: 1.8.2
+Version: 1.9.1
 Summary: OpenTelekomCloud Docs Theme
 Home-page: https://cloud.otc.com
 Author: Artem Goncharov

{otcdocstheme-1.8.2 → otcdocstheme-1.9.1}/bindep.txt

@@ -16,6 +16,7 @@ zlib1g-dev [platform:dpkg]
 inkscape
 texlive-latex-base [platform:dpkg]
 texlive-latex-extra [platform:dpkg]
+texlive-background [platform:rpm]
 texlive-xetex [platform:dpkg]
 texlive-fonts-recommended [platform:dpkg]
 fonts-freefont-otf [platform:dpkg]

otcdocstheme-1.9.1/doc/source/_templates/longtable.tex.jinja

@@ -0,0 +1,84 @@
+\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 == 'default' %>
+  \LTleft 0cm
+  \LTright 0cm
+<%- elif table.align == 'center' %>
+  \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
+<% set total_width = table.colwidths|sum %>
+<% set colspec_parts = [] %>
+<% for width in table.colwidths %>
+  <% set part = 'p{{{:.4f}\\textwidth}}'.format((width * 0.863) / total_width) %>
+  <% set colspec_parts = colspec_parts.append(part) %>
+<% endfor  %>
+<% set colspec_string = ''.join(colspec_parts) %>
+\begin{longtable}{<%= colspec_string %>}
+<%- 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}

otcdocstheme-1.9.1/doc/source/_templates/tabular.tex copy.jinja

@@ -0,0 +1,62 @@
+\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') -%>
+  \raggedleft
+  <%- elif table.align == 'left' -%>
+  \raggedleft
+  <%- else -%>
+  \raggedleft
+  <%- endif %>
+<%- else -%>
+  \raggedleft
+<%- endif %>
+<% if table.caption -%>
+\sphinxcapstartof{table}
+\sphinxthecaptionisattop
+\sphinxcaption{<%= ''.join(table.caption) %>}<%= labels %>
+\sphinxcaption{<%= table.colwidths|sum %>}<%= labels %>
+\sphinxaftertopcaption
+<% elif labels -%>
+\phantomsection<%= labels %>\nobreak
+<% endif -%>
+<% set total_width = table.colwidths|sum %>
+<% set colspec_parts = [] %>
+<% for width in table.colwidths %>
+  <% set part = 'p{{{:.4f}\\textwidth}}'.format((width * 0.8) / total_width) %>
+  <% set colspec_parts = colspec_parts.append(part) %>
+<% endfor  %>
+<% set colspec_string = ''.join(colspec_parts) %>
+\begin{tabularx}{\linewidth}{<%= colspec_string %>}
+\sphinxtoprule
+<%= ''.join(table.header) -%>
+<%- if table.header -%>
+\sphinxmidrule
+<% endif -%>
+\sphinxtableatstartofbodyhook
+<%=- ''.join(table.body) -%>
+\sphinxbottomrule
+\end{tabularx}
+\sphinxtableafterendhook\par
+\sphinxattableend\end{savenotes}

otcdocstheme-1.9.1/doc/source/_templates/tabular.tex.jinja

@@ -0,0 +1,85 @@
+\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 == 'default' %>
+  \LTleft 0cm
+  \LTright 0cm
+<%- elif table.align == 'center' %>
+  \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
+<% set total_width = table.colwidths|sum %>
+<% set colspec_parts = [] %>
+<% for width in table.colwidths %>
+  <% set part = 'p{{{:.4f}\\textwidth}}'.format((width * 0.863) / total_width) %>
+  <% set colspec_parts = colspec_parts.append(part) %>
+<% endfor  %>
+<% set colspec_string = ''.join(colspec_parts) %>
+\begin{longtable}{<%= colspec_string %>}
+<%- 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
+\raggedright
+<%= ''.join(table.body) -%>
+\sphinxbottomrule
+\end{longtable}
+\sphinxtableafterendhook
+\sphinxatlongtableend
+\end{savenotes}

otcdocstheme-1.9.1/doc/source/_templates/tabulary.tex.jinja

@@ -0,0 +1,54 @@
+\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}

{otcdocstheme-1.8.2 → otcdocstheme-1.9.1}/doc/source/conf.py

@@ -70,6 +70,7 @@ html_theme_options = {
 # 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/css']
+templates_path = ['_templates']
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -86,4 +87,17 @@ latex_documents = [
 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')
+current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')
+
+latex_elements = {
+  'papersize': 'a4paper',
+  'pointsize': '12pt',
+  'figure_align': 'H',
+  'preamble': rf'''
+        \newcommand{{\githash}}{{{current_commit_hash}}}
+        \newcommand{{\gitcommittime}}{{{current_commit_time}}}
+        \newcommand{{\doctitle}}{{{otcdocs_doc_title}}}
+        \newcommand{{\servicetitle}}{{{otcdocs_service_title}}}
+  ''',
+  'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
+}

{otcdocstheme-1.8.2 → otcdocstheme-1.9.1}/otcdocstheme/ext.py

@@ -13,17 +13,17 @@
 #    under the License.
 
 import configparser
-import os
-import subprocess
-import textwrap
-
 from docutils.nodes import Element
 import dulwich.repo
+import glob
+import os
 from pbr import packaging
 import sphinx
 from sphinx.ext import extlinks
 from sphinx.util import logging
 from sphinx.writers.html5 import HTML5Translator
+import subprocess
+import textwrap
 
 from . import version
 from otcdocstheme import paths
@@ -466,12 +466,7 @@ def _builder_inited(app):
 
     theme_logo = paths.get_theme_logo_path(app.config.html_theme)
     pdf_theme_path = paths.get_pdf_theme_path(app.config.html_theme)
-    latex_elements = {
-        'papersize': 'a4paper',
-        'pointsize': '11pt',
-        'figure_align': 'H',
-        'classoptions': ',openany',
-    }
+    latex_elements = {}
 
     if app.config.latex_elements:
         latex_elements.update(app.config.latex_elements)
@@ -488,8 +483,19 @@ def _builder_inited(app):
 
     latex_elements['preamble'] = preamble
 
+    u1_path = paths.get_pdf_blobs_u1_path(app.config.html_theme)
+    u4_path = paths.get_pdf_blobs_u4_path(app.config.html_theme)
+    latex_additional_files = [
+        f'{pdf_theme_path}.sty', u1_path, u4_path
+    ]
+
+    fonts_path = paths.get_theme_fonts_path(app.config.html_theme)
+
+    for file in glob.glob(fonts_path + "/*.ttf"):
+        latex_additional_files.append(file)
+
     app.config.latex_elements = latex_elements
-    app.config.latex_additional_files = [f'{pdf_theme_path}.sty']
+    app.config.latex_additional_files = latex_additional_files
 
     # This hook is invoked when latex builder is already initialized. We loose
     # preamble if we only set it to the config

{otcdocstheme-1.8.2 → otcdocstheme-1.9.1}/otcdocstheme/paths.py

@@ -32,5 +32,23 @@ def get_pdf_theme_path(theme='otcdocs'):
 
 def get_theme_logo_path(theme='otcdocs'):
     """Return the directory containing theme logo for local builds."""
-    args = ['theme', theme + '_pdf', 'deutsche-telekom-logo.png']
+    args = ['theme', theme + '_pdf', 'T-logo.pdf']
+    return os.path.join(get_pkg_path(), *args)
+
+
+def get_theme_fonts_path(theme='otcdocs'):
+    """Return the directory containing fonts for local builds."""
+    args = ['theme', theme + '_pdf', 'fonts']
+    return os.path.join(get_pkg_path(), *args)
+
+
+def get_pdf_blobs_u1_path(theme='otcdocs'):
+    """Return the directory containing PDF theme for local builds."""
+    args = ['theme', theme + '_pdf', 'u1-blobs.pdf']
+    return os.path.join(get_pkg_path(), *args)
+
+
+def get_pdf_blobs_u4_path(theme='otcdocs'):
+    """Return the directory containing PDF theme for local builds."""
+    args = ['theme', theme + '_pdf', 'u4-blobs.pdf']
     return os.path.join(get_pkg_path(), *args)

{otcdocstheme-1.8.2 → otcdocstheme-1.9.1}/otcdocstheme/theme/otcdocs/script_footer.html

@@ -42,12 +42,9 @@
       };
 </script>
 
-<!-- Tracking test for docs-int -->
 {% if otcdocs_doc_environment == 'internal' %}
-    <noscript>
-        <img src="https://shynet.eco.tsi-dev.otc-service.com/ingress/f3f8d596-b9d7-4c54-9cb2-7c8df6757996/pixel.gif">
-    </noscript>
-    <script defer src="https://shynet.eco.tsi-dev.otc-service.com/ingress/f3f8d596-b9d7-4c54-9cb2-7c8df6757996/script.js"></script>
+<!-- Tracking test for docs-int -->
+<script defer src="https://analytics.otc-service.com/script.js" data-website-id="30235e74-aad1-4afd-aa3d-1281b79b7ec3"></script>
 {% endif %}
 
 <!-- Javascript for page -->