From 0e4ca7fd50fbb0231547dc2f95ba20904134a5df Mon Sep 17 00:00:00 2001 From: "Gode, Sebastian" Date: Wed, 16 Oct 2024 11:41:25 +0000 Subject: [PATCH] Update tox.ini && conf.py file Reviewed-by: tischrei Co-authored-by: Gode, Sebastian Co-committed-by: Gode, Sebastian --- api-ref/source/conf.py | 11 ++++++++++- doc/source/conf.py | 11 ++++++++++- tox.ini | 6 ++++++ umn/source/conf.py | 11 ++++++++++- 4 files changed, 36 insertions(+), 3 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 7234b7b..1883ed1 100755 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -106,6 +106,7 @@ html_title = "Resource Formation Service - 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 @@ -122,4 +123,12 @@ 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') \ No newline at end of file +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' +} \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 1322257..3f8a941 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -107,6 +107,7 @@ html_title = "Resource Formation Service - 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 @@ -118,4 +119,12 @@ 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') \ No newline at end of file +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' +} \ No newline at end of file diff --git a/tox.ini b/tox.ini index c3f711f..032f4de 100644 --- a/tox.ini +++ b/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:api-ref-pdf-docs]commands} {[testenv:umn-pdf-docs]commands} @@ -100,6 +104,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" @@ -146,6 +151,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" diff --git a/umn/source/conf.py b/umn/source/conf.py index 33c0039..3f3f387 100755 --- a/umn/source/conf.py +++ b/umn/source/conf.py @@ -106,6 +106,7 @@ html_title = "Resource Formation Service - 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 @@ -122,4 +123,12 @@ 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') \ No newline at end of file +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' +} \ No newline at end of file