Skip to content

Commit e1e3e89

Browse files
committed
docs: initial docs setup
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
1 parent 95cf809 commit e1e3e89

File tree

275 files changed

+153
-30021
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

275 files changed

+153
-30021
lines changed

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ end_of_line = lf
1111
[*.py]
1212
max_line_length = 88
1313

14-
[*.{sh,yml,yaml,json}]
14+
[*.{sh,yml,yaml,json,md}]
1515
indent_size = 2

.github/ISSUE_TEMPLATE/bug_report.yml

-50
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

-5
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.yml

-40
This file was deleted.

.github/workflows/deploy-docs.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy Documentation
2+
on:
3+
workflow_dispatch:
4+
push:
5+
branches:
6+
- docs
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Configure Git Credentials
15+
run: |
16+
git config user.name github-actions[bot]
17+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: 3.x
21+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
22+
- uses: actions/cache@v4
23+
with:
24+
key: mkdocs-material-${{ env.cache_id }}
25+
path: .cache
26+
restore-keys: |
27+
mkdocs-material-
28+
- name: Install dependencies
29+
run: pip install -r requirements.txt
30+
- name: Build and deploy documentation
31+
run: mkdocs gh-deploy --force

.github/workflows/release-ff-and-tag.yml

-33
This file was deleted.

.shellcheckrc

-15
This file was deleted.

Dockerfile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
FROM squidfunk/mkdocs-material:latest
2+
3+
# Install additional plugins required by our mkdocs configuration
4+
RUN pip install \
5+
mkdocs-git-revision-date-localized-plugin \
6+
mkdocstrings[python]

0 commit comments

Comments
 (0)