search

opentelekomcloud-docs / distributed-cache-service

Open Telekom Cloud Distributed Cache Service docs
Apache License 2.0
0 stars 0 forks source link

Propagate changes to distributed-cache-service-api-ref from PreProd environment #36

Closed otcbot[bot] closed 1 year ago

otcbot[bot] commented 1 year ago

This is an automatically created Pull Request for changes to distributed-cache-service-api-ref to promote changes down the pipeline to Production environment.

The original change can be found under https://gitea.eco.tsi-dev.otc-service.com/docs/distributed-cache-service/pulls/61.

There were patch conflicts, please review original patch file.

otcbot[bot] commented 1 year ago

I tried my best, but could not apply the patch as is, therefore I will report you what I could not apply.

BTW, if in the diff you see removed line equal to the added line it may be caused by invisible trailing spaces. This is safe to ignore.

In most cases content of the patch remainder need to be carefully analyzed and necessary changes applied manually.

Following is the patch remainder:

diff a/tox.ini b/tox.ini    (rejected hunks)
@@ -34,14 +34,15 @@ allowlist_externals =
   rm
   sphinx-build
 commands =
-  rm -rf doc/build/html doc/build/doctrees
-  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
+  rm -rf doc/build/html doc/build/html_temp doc/build/doctrees
+  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp
+  sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
   {[testenv:api-ref]commands}
   {[testenv:json-api-ref]commands}
-  {[testenv:umn]commands}
-  {[testenv:json-umn]commands}
   {[testenv:best-practice]commands}
   {[testenv:json-best-practice]commands}
+  {[testenv:umn]commands}
+  {[testenv:json-umn]commands}

 [testenv:docs-pdf]
 deps = {[testenv:docs]deps}
@@ -54,8 +55,8 @@ allowlist_externals =
 commands =
   mkdir -p doc/build/pdf
   {[testenv:api-ref-pdf-docs]commands}
-  {[testenv:umn-pdf-docs]commands}
   {[testenv:best-practice-pdf-docs]commands}
+  {[testenv:umn-pdf-docs]commands}

 # HTML version
@@ -139,39 +142,44 @@ allowlist_externals =
   bash
   cp
 commands =
-  rm -rf umn/build/pdf
-  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
+  rm -rf doc/best-practice/build/pdf
+  sphinx-build -W --keep-going -b latex doc/best-practice/source doc/best-practice/build/pdf/
+  bash -c "for f in doc/best-practice/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
+  bash -c "for f in doc/best-practice/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
+  make -C doc/best-practice/build/pdf
   mkdir -p doc/build/pdf
-  cp umn/build/pdf/dcs-umn.pdf doc/build/pdf/
+  cp doc/best-practice/build/pdf/dcs-best-practice.pdf doc/build/pdf/

 # HTML version
-[testenv:best-practice]
+[testenv:umn]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   cp
   mkdir
 commands =
-  sphinx-build -W --keep-going -b html doc/best-practice/source doc/build/html/best-practice
+  sphinx-build -W --keep-going -b html umn/source doc/build/html_temp/umn
+  sphinx-minify --input-directory doc/build/html_temp/umn --output-directory doc/build/html/umn
+  mkdir -p umn/build/html
+  cp -av doc/build/html/umn umn/build/html

 # Json version (for search)
-[testenv:json-best-practice]
+[testenv:json-umn]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   cp
   mkdir
   sh
 commands =
-  sphinx-build -W --keep-going -b json doc/best-practice/source doc/build/json/best-practice
+  sphinx-build -W --keep-going -b json umn/source doc/build/json/umn
   # Drop data useless for the search - wrap it also with sh/xargs due to bugs
   # in tox
   sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
+  mkdir -p umn/build/json
+  cp -av doc/build/json/umn umn/build/json

 # PDF version
-[testenv:best-practice-pdf-docs]
+[testenv:umn-pdf-docs]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   rm
@@ -180,13 +188,13 @@ allowlist_externals =
   bash
   cp
 commands =
-  rm -rf doc/best-practice/build/pdf
-  sphinx-build -W --keep-going -b latex doc/best-practice/source doc/best-practice/build/pdf/
-  bash -c "for f in doc/best-practice/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
-  bash -c "for f in doc/best-practice/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
-  make -C doc/best-practice/build/pdf
+  rm -rf umn/build/pdf
+  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 doc/best-practice/build/pdf/dcs-best-practice.pdf doc/build/pdf/
+  cp umn/build/pdf/dcs-umn.pdf doc/build/pdf/

diff a/doc/source/conf.py b/doc/source/conf.py  (rejected hunks)
@@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/distributed-cache-service'
 otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
 otcdocs_git_type = 'gitea'

+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = ''
+otcdocs_doc_link = ''
+otcdocs_doc_title = ''
+otcdocs_doc_type = ''
+otcdocs_service_category = 'database'
+otcdocs_service_title = 'Distributed Cache Service'
+otcdocs_service_type = 'dcs'
+otcdocs_search_environment = 'hc_de'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.