infra/otc-metadata-rework
14
0
Fork 4
Code Issues 3 Pull Requests 1 Actions Packages Releases Wiki Activity

Add filter to json builds to prevent search indexing on hidden documents (#56)
All checks were successful
Create Weekly Analytics Stats / run-analytics (push) Successful in 11s
Details

Browse Source 
Reviewed-on: #56
Reviewed-by: Tino Schreiber <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
This commit is contained in:
Gode, Sebastian
2025-09-09 12:12:31 +00:00
committed by Tino Schreiber
parent bd563ca9eb
commit 8c2aa088e9
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
otc_metadata/templates/tox.ini.j2
View File

@ -41,7 +41,11 @@ commands =
sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
{%- for doc in docs %} {%- for doc in docs %}
{[testenv:{{ doc.type }}]commands} {[testenv:{{ doc.type }}]commands}
{#- To avoid hidden documents to be searchable -#}
{%- if (target_environment == 'internal' and doc.visibility != 'hidden')
or (target_environment == 'public' and doc.visibility == 'public') %}
{[testenv:json-{{ doc.type }}]commands} {[testenv:json-{{ doc.type }}]commands}
{%- endif %}
{%- endfor %} {%- endfor %}
{% if docs|length > 0 %} {% if docs|length > 0 %}
@ -90,6 +94,10 @@ commands =
cp -av doc/build/html/{{ doc.type }} {{ doc.type }}/build/html cp -av doc/build/html/{{ doc.type }} {{ doc.type }}/build/html
{%- endif %} {%- endif %}
{#- To avoid hidden documents to be searchable -#}
{%- if (target_environment == 'internal' and doc.visibility != 'hidden')
or (target_environment == 'public' and doc.visibility == 'public') %}
# Json version (for search) # Json version (for search)
[testenv:json-{{ doc.type }}] [testenv:json-{{ doc.type }}]
deps = {[testenv:docs]deps} deps = {[testenv:docs]deps}
@ -109,6 +117,7 @@ commands =
mkdir -p {{ doc.type }}/build/json mkdir -p {{ doc.type }}/build/json
cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
{%- endif %} {%- endif %}
{%- endif %}
# PDF version # PDF version
[testenv:{{ doc.type }}-pdf-docs] [testenv:{{ doc.type }}-pdf-docs]

1
tools/generate_doc_confpy.py
View File

@ -316,6 +316,7 @@ def process_repositories(args, service):
if doc["type"] == "dev": if doc["type"] == "dev":
doc["type"] = "dev-guide" doc["type"] = "dev-guide"
doc["pdf_enabled"] = cloud_environment["pdf_enabled"] doc["pdf_enabled"] = cloud_environment["pdf_enabled"]
doc["visibility"] = cloud_environment["visibility"]
context["docs"].append(doc) context["docs"].append(doc)
context["target_environment"] = args.target_environment context["target_environment"] = args.target_environment