dadrobna/gaussdb-mysql
1
0
Fork 0
forked from docs/gaussdb-mysql
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 2023-11-06 14:03:25 +00:00
parent 632e92a69a
commit aba481bd57
3 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/requirements.txt
View File

@ -1,7 +1,10 @@
sphinx>=2.0.0,!=2.1.0 # BSD
otcdocstheme # Apache-2.0
# releasenotes
reno>=3.1.0 # Apache-2.0
otc-sphinx-directives>=0.1.0
sphinx-minify>=0.0.1 # Apache-2.0
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

11
doc/source/conf.py
View File

@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/gaussdb-mysql'
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 = 'GaussDB (for MySQL)'
otcdocs_service_type = 'gaussdb_mysql'
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.

11
tox.ini
View File

@ -34,8 +34,9 @@ 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}
@ -62,7 +63,8 @@ allowlist_externals =
cp
mkdir
commands =
sphinx-build -W --keep-going -b html api-ref/source doc/build/html/api-ref
sphinx-build -W --keep-going -b html api-ref/source doc/build/html_temp/api-ref
sphinx-minify --input-directory doc/build/html_temp/api-ref --output-directory doc/build/html/api-ref
mkdir -p api-ref/build/html
cp -av doc/build/html/api-ref api-ref/build/html
@ -107,7 +109,8 @@ allowlist_externals =
cp
mkdir
commands =
sphinx-build -W --keep-going -b html umn/source doc/build/html/umn
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