Skip to content

Commit cddbfca

Browse files
committed
fix
1 parent 7fe72d1 commit cddbfca

File tree

6 files changed

+21
-11
lines changed

6 files changed

+21
-11
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ It provides functionalities for *Access Key* and *Secret Access Key* (AK/SK) req
77

88
## Documentation
99

10+
For documentation see: [otc-java-sdk-v1](https://opentelekomcloud-community.github.io/otc-java-sdk-v1/)
11+
1012
>[!NOTE]
1113
> To run documentation locally:
1214
>

doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
docutils>=0.11 # OSI-Approved Open Source, Public Domain
55
beautifulsoup4>=4.6.0 # MIT
66
reno>=4.1.0 # Apache-2.0
7-
otcdocstheme>=1.12.7 # Apache-2.0
7+
otcdocstheme>=1.13.2 # Apache-2.0
88
otc-api-ref>=0.1.0 # Apache-2.0
99
sphinx>=2.0.0,!=2.1.0 # BSD
1010
sphinxcontrib-apidoc>=0.2.0 # BSD
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<aside id="left-sidebar" class="docs-sidebar">
2+
<div class="docs-sidebar-toc collapse" aria-label="Docs navigation" id="docs-sidebar-nav">
3+
{%- if theme_display_global_toc_section %}
4+
<div class="docs-sidebar-section" id="table-of-contents">
5+
<!-- <a href="../{{ pathto(master_doc) }}" class="docs-sidebar-section-title"><h4>{{project}} {{version}}</h4></a> -->
6+
<a href="/index.html" class="docs-sidebar-section-title"><h4>{{project}} {{version}}</h4></a>
7+
{%- if theme_sidebar_mode == 'toc' %}
8+
{{ toc }}
9+
{%- elif theme_sidebar_mode == 'toctree' %}
10+
{{ toctree(maxdepth=4, includehidden=True, titles_only=true) }}
11+
{%- endif %}
12+
</div>
13+
{%- endif %}
14+
</div>
15+
</aside>

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@
163163
# further. For a list of options available for each theme, see the
164164
# documentation.
165165
html_theme_options = {
166-
"show_other_versions": "True",
166+
"show_other_versions": "False",
167167
"logo_url": "https://docs.otc.t-systems.com",
168168
}
169169

doc/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
OTC Java SDK v1 documentation
22
=============================
33

4-
The `OTC Java SDK v1` provides functionality to use
4+
The `OTC Java SDK v1` provides functionality to use the
55
OpenTelekomCloud API in Java.
66

7-
Escpecially methods for signing requests using AK/SK
7+
Especially methods for signing requests using AK/SK
88

99
.. toctree::
1010
:includehidden:

tox.ini

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,3 @@ deps =
2222
-r{toxinidir}/doc/requirements.txt
2323
commands =
2424
sphinx-build -W --keep-going -b html releasenotes/source releasenotes/build/html
25-
26-
[testenv:gh-pages]
27-
passenv = GH_ACTIONS_*
28-
deps =
29-
-r{toxinidir}/doc/requirements.txt
30-
commands =
31-
sphinx-build -W --keep-going -b html doc/source/ docs/_build/html

0 commit comments

Comments
 (0)