Compare commits

...

1 Commits

Author SHA1 Message Date
6f711fe7fe Update tox.ini && conf.py file
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
2025-02-07 11:19:58 +00:00
2 changed files with 50 additions and 2 deletions

48
tox.ini
View File

@ -44,6 +44,7 @@ commands =
{[testenv:umn]commands} {[testenv:umn]commands}
{[testenv:json-umn]commands} {[testenv:json-umn]commands}
[testenv:pdf-docs] [testenv:pdf-docs]
deps = deps =
{[testenv:docs]deps} {[testenv:docs]deps}
@ -57,11 +58,16 @@ allowlist_externals =
cp cp
commands = commands =
mkdir -p doc/build/pdf mkdir -p doc/build/pdf
mkdir -p doc/build/html
{[testenv:bindeps]commands} {[testenv:bindeps]commands}
mkdir -p {toxinidir}/_templates 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/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/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 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}
# HTML version # HTML version
[testenv:api-ref] [testenv:api-ref]
@ -90,6 +96,26 @@ commands =
mkdir -p api-ref/build/json mkdir -p api-ref/build/json
cp -av doc/build/json/api-ref api-ref/build/json cp -av doc/build/json/api-ref api-ref/build/json
# PDF version
[testenv:api-ref-pdf-docs]
deps = {[testenv:docs]deps}
allowlist_externals =
rm
mkdir
make
bash
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"
make -C api-ref/build/pdf
mkdir -p doc/build/pdf
cp api-ref/build/pdf/rfs-api-ref.pdf doc/build/pdf/
cp api-ref/build/pdf/rfs-api-ref.pdf doc/build/html/
# HTML version # HTML version
[testenv:umn] [testenv:umn]
deps = {[testenv:docs]deps} deps = {[testenv:docs]deps}
@ -117,6 +143,26 @@ commands =
mkdir -p umn/build/json mkdir -p umn/build/json
cp -av doc/build/json/umn umn/build/json cp -av doc/build/json/umn umn/build/json
# PDF version
[testenv:umn-pdf-docs]
deps = {[testenv:docs]deps}
allowlist_externals =
rm
mkdir
make
bash
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"
make -C umn/build/pdf
mkdir -p doc/build/pdf
cp umn/build/pdf/rfs-umn.pdf doc/build/pdf/
cp umn/build/pdf/rfs-umn.pdf doc/build/html/
[testenv:bindeps] [testenv:bindeps]
deps = deps =
@ -135,4 +181,4 @@ commands =
[doc8] [doc8]
ignore = D001 ignore = D001
extensions = .rst, .yaml extensions = .rst, .yaml

View File

@ -6,9 +6,11 @@
- helpcenter-base-jobs - helpcenter-base-jobs
vars: vars:
sphinx_pdf_files: sphinx_pdf_files:
- rfs-api-ref.pdf
- rfs-umn.pdf
check: check:
jobs: jobs:
- noop - noop
gate: gate:
jobs: jobs:
- noop - noop