forked from docs/internal-documentation
Gode, Sebastian
0f2913bdb4
Reviewed-by: tischrei <tino.schreiber@t-systems.com> Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
21 lines
1.6 KiB
ReStructuredText
21 lines
1.6 KiB
ReStructuredText
================
|
|
Conf.Py Settings
|
|
================
|
|
|
|
The otcdocstheme provides a variety of configuration options which can be specified in each projects conf.py
|
|
|
|
1. repo_name = Name of the Repository which gets displayed on the left side of the HTML page
|
|
2. edit_enabled = Whether the `Edit page` button on the right side is being rendered or not
|
|
3. bug_report_enabled = Whether the `Report Documentation Bug` button on the right side is being rendered or not
|
|
4. doc_environment = `public` or `internal` to differentiate search
|
|
5. doc_link = The link to this document category, e.g. `/application-operations-management/umn/`
|
|
6. doc_title = The title of this document category, e.g. `User Guide`
|
|
7. doc_type = The type of this document, e.g. `umn`, limited to the following selection: https://github.com/opentelekomcloud/otc-sphinx-directives/blob/main/otc_sphinx_directives/service_card.py#L54
|
|
8. service_title = The service title, e.g. `Application Operations Management`
|
|
9. service_type = The service type, e.g. `aom`, limited to the following selection https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/services
|
|
10. service_category = The service category, e.g. `application`, limited to the following selection https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/service_categories
|
|
11. otcdocs_search_environment = Name of the search index, e.g. `hc_de`, limited to `hc_de` or `hc_swiss`
|
|
12. otcdocs_search_index = Search index wildcard name, e.g. `helpcenter-`, default: `helpcenter-`
|
|
13. otcdocs_search_url = Search URL for OpenSearch, e.g. `https://opensearch.eco.tsi-dev.otc-service.com/`
|
|
|