Update content

api-ref/source/conf.py

@@ -115,7 +115,7 @@ html_copy_source = False
 latex_documents = [
     ('index',
      'rfs-api-ref.tex',
-    u'Resource Formation Service - API Reference',
+     u'Resource Formation Service - API Reference',
      u'OpenTelekomCloud', 'manual'),
 ]
 

api-ref/source/index.rst

@@ -1,3 +1,4 @@
-==========================================================
+==========================================
-Welcome to the documentation of resource-formation-service
+Resource Formation Service - API Reference
-==========================================================
+==========================================
+

doc/source/conf.py

@@ -125,11 +125,6 @@ latex_elements = {
   'papersize': 'a4paper',
   'pointsize': '12pt',
   'figure_align': 'H',
-  'preamble': rf'''
+  'preamble': r'\newcommand{\githash}{' + current_commit_hash + '}',
-        \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'
 }

doc/source/index.rst

@@ -1,11 +1,9 @@
 Resource Formation Service
 ==========================
 
-With Resource Formation Service, you can manage system and service resources (all physical or logical entities that can be located and described, such as databases, VPCs, pipelines, and IAM roles). You can automatically deploy specified cloud service resources based on the template which uses the HCL (an open ecosystem) syntax.
-
 .. directive_wrapper::
    :class: container-sbv
 
    .. service_card::
       :service_type: rfs
-      :umn: This document describes basic concepts, functions, key terms, and FAQs of the Resource Formation Service (RFS) and provides guidances for creating private templates, stacks, execution plans and so on.
+      :environment: internal

tox.ini

@@ -44,6 +44,27 @@ commands =
   {[testenv:umn]commands}
   {[testenv:json-umn]commands}
 
+[testenv:docs-pdf]
+deps =
+  {[testenv:docs]deps}
+  {[testenv:bindeps]deps}
+allowlist_externals =
+  rm
+  mkdir
+  wget
+  make
+  bash
+  cp
+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}
+
 
 # HTML version
 [testenv:api-ref]
@@ -85,12 +106,12 @@ 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[0] $\{f/%gif/png\}; done || true"
+  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 LATEXMKOPTS="-interaction=nonstopmode"
+  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
 [testenv:umn]
@@ -132,12 +153,12 @@ 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[0] $\{f/%gif/png\}; done || true"
+  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 LATEXMKOPTS="-interaction=nonstopmode"
+  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]