lbelejka/cloud-firewall
1
0
Fork 0
forked from docs/cloud-firewall
Code Pull Requests Activity

Update tox.ini && conf.py file

Browse Source 
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
This commit is contained in:
Gode, Sebastian 2024-10-15 11:27:59 +00:00
parent 3dd078e8cc
commit 84e92bf75e
4 changed files with 36 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api-ref/source/conf.py
View File

@ -106,6 +106,7 @@ html_title = "Cloud Firewall - 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')
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'
}

11
doc/source/conf.py
View File

@ -107,6 +107,7 @@ html_title = "Cloud Firewall - 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')
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'
}

6
tox.ini
View File

@ -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:umn-pdf-docs]commands}
{[testenv:api-ref-pdf-docs]commands}
@ -100,6 +104,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"
@ -146,6 +151,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"

11
umn/source/conf.py
View File

@ -106,6 +106,7 @@ html_title = "Cloud Firewall - 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')
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'
}