Skip to content

Commit 63c5168

Browse files
harald-tsysharald-tsys
committed
initial commit
1 parent 41f1d7e commit 63c5168

File tree

23 files changed

+1424
-0
lines changed

23 files changed

+1424
-0
lines changed

‎.github/workflows/publishGitHubPages.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Publish GitHub Pages
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
8+
push:
9+
branches:
10+
- main
11+
12+
# Allows you to run this workflow manually from the Actions tab
13+
workflow_dispatch:
14+
15+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
21+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
22+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
23+
concurrency:
24+
group: "pages"
25+
cancel-in-progress: false
26+
27+
jobs:
28+
build:
29+
runs-on: ubuntu-latest
30+
31+
steps:
32+
- name: Checkout code
33+
uses: actions/checkout@v4
34+
35+
- name: Set up Python
36+
uses: actions/setup-python@v5
37+
with:
38+
python-version: "3.12"
39+
40+
- name: Install dependencies
41+
run: |
42+
python -m pip install --upgrade pip
43+
pip install -r doc/requirements.txt
44+
45+
- name: get git info
46+
id: getgitinfo
47+
run: |
48+
echo "GITHUB_COMMIT_DATE=$(git --no-pager log -1 --pretty='format:%cd' --date='format:%Y-%m-%d %H:%M:%S')" >> "$GITHUB_OUTPUT"
49+
50+
- name: Setup Pages
51+
id: pages
52+
uses: actions/configure-pages@v5
53+
54+
- name: build Documentation
55+
env:
56+
GH_ACTIONS_GIT_BRANCH: ${{ github.head_ref || github.ref_name }}
57+
GH_ACTIONS_GIT_COMMIT_DATE: ${{ steps.getgitinfo.outputs.GITHUB_COMMIT_DATE }}
58+
GH_ACTIONS_GIT_COMMIT_HASH: ${{ github.sha }}
59+
60+
run: |
61+
sphinx-build -W --keep-going -b html doc/source/ ./_site
62+
63+
- name: Upload artifact
64+
# Automatically uploads an artifact from the './_site' directory by default
65+
uses: actions/upload-pages-artifact@v3
66+
67+
# Deployment job
68+
deploy:
69+
environment:
70+
name: github-pages
71+
url: ${{ steps.deployment.outputs.page_url }}
72+
runs-on: ubuntu-latest
73+
needs: build
74+
steps:
75+
- name: Deploy to GitHub Pages
76+
id: deployment
77+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
local-dotnet
2+
bin/
3+
obj/
4+
dotnet-install.sh
5+
build
6+
# Ignore NuGet Packages
7+
*.nupkg
8+
.tox

‎README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
# otc-api-sign-sdk-csharp
22
SDK for API request signing for C#
3+
4+
5+
> [!Note]
6+
> <pre>
7+
> ###############################################
8+
> Work in progress....
9+
> ###############################################
10+
> </pre>
11+
>
12+
13+
## Documentation
14+
15+
For documentation see: [otc-api-sign-sdk-csharp](https://opentelekomcloud-community.github.io/otc-api-sign-sdk-csharp/)
16+
17+
18+
>[!NOTE]
19+
> To run documentation locally:
20+
>
21+
> Install ``tox`` as described in: [tox installation guide ](https://tox.wiki/en/4.26.0/installation.html)
22+
>
23+
> and run:
24+
>
25+
> ```bash
26+
> tox -e docs-auto
27+
> ```
28+
> Open documentation in browser: <http://127.0.0.1:8882>
29+
30+
31+
> Warranty Disclaimer
32+
> -------------------
33+
> THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT
34+
> WILL BE USEFUL,BUT WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY
35+
> OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
36+
>
37+
> SEE THE APPLICABLE LICENSES FOR MORE DETAILS.

‎doc/requirements.txt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# The order of packages is significant, because pip processes them in the order
2+
# of appearance. Changing the order has an impact on the overall integration
3+
# process, which may cause wedges in the gate later.
4+
docutils>=0.11 # OSI-Approved Open Source, Public Domain
5+
beautifulsoup4>=4.6.0 # MIT
6+
reno>=4.1.0 # Apache-2.0
7+
otcdocstheme>=1.13.2 # Apache-2.0
8+
otc-api-ref>=0.1.0 # Apache-2.0
9+
sphinx>=2.0.0,!=2.1.0 # BSD
10+
sphinxcontrib-apidoc>=0.2.0 # BSD
11+
# cliff!=2.9.0,>=2.8.0 # Apache-2.0
12+
oslo.i18n>=3.15.3 # Apache-2.0
13+
osc-lib>=1.10.0 # Apache-2.0
14+
doc8
15+
rstcheck
16+
javasphinx
17+
sphinx-tabs
18+
sphinx-copybutton
19+
sphinx-design
20+
Sphinx-Substitution-Extensions
21+
gitpython
22+
sphinx-autobuild
23+
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata-rework.git#egg=otc_metadata

‎doc/setup.cfg‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[rstcheck]
2+
ignore_roles=github_repo_master
3+
4+
[doc8]
5+
ignore = ["D001"]
6+
allow-long-titles = true

‎doc/source/_static/css/custom.css‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/* START: Copy to Clipboard */
2+
3+
button.copybtn {
4+
webkit-transition: opacity .3s ease-in-out;
5+
-o-transition: opacity .3s ease-in-out;
6+
transition: opacity .3s ease-in-out;
7+
opacity: 0;
8+
padding: 0px 6px;
9+
position: absolute;
10+
right: 4px;
11+
top: 4px;
12+
}
13+
div.highlight:hover .copybtn, div.highlight .copybtn:focus {
14+
opacity: .5;
15+
}
16+
div.highlight .copybtn:hover {
17+
opacity: 1;
18+
color: var(--telekom-color-primary-standard);
19+
}
20+
21+
div.highlight .btn:focus {
22+
box-shadow: 0 0 0 .25rem rgba(226, 0, 116,.25);
23+
}
24+
25+
div.highlight {
26+
position: relative;
27+
}
28+
29+
.fa-solid, .fas {
30+
font-family: "Font Awesome 6 Free";
31+
font-weight: 900;
32+
}
33+
34+
/* END: Copy to Clipboard */

‎doc/source/_templates/sidebartoc.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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+
{%- if theme_sidebar_mode == 'toc' %}
7+
{{ toc }}
8+
{%- elif theme_sidebar_mode == 'toctree' %}
9+
{{ toctree(maxdepth=4, includehidden=True, titles_only=true) }}
10+
{%- endif %}
11+
</div>
12+
{%- endif %}
13+
</div>
14+
</aside>

0 commit comments

Comments
 (0)