Add documentation (#26)

This commit is contained in:
struga 2022-08-25 15:19:03 +03:00 committed by GitHub
parent b090195a28
commit 9a019ddf56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 64 additions and 48 deletions

30
.github/workflows/build-docs.yml vendored Normal file
View File

@ -0,0 +1,30 @@
name: build
on:
- pull_request
env:
PYTHON_VERSION: 3.x
jobs:
documentation:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Python runtime
uses: actions/setup-python@v1
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Install Python dependencies
run: |
pip install -r requirements.txt
- name: Install theme
run: |
pip install mkdocs-gitbook
- name: Build documentation
run: |
mkdocs build
mkdocs --version

View File

@ -8,26 +8,3 @@ on:
jobs: jobs:
build: build:
uses: valitydev/java-workflow/.github/workflows/maven-library-build.yml@v1 uses: valitydev/java-workflow/.github/workflows/maven-library-build.yml@v1
documentation:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Python runtime
uses: actions/setup-python@v1
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Install Python dependencies
run: |
pip install -r requirements.txt
- name: Install theme
run: |
pip install mkdocs-gitbook
- name: Build documentation
run: |
mkdocs build
mkdocs --version

34
.github/workflows/deploy-docs.yml vendored Normal file
View File

@ -0,0 +1,34 @@
name: deploy
on:
push:
branches:
- master
env:
PYTHON_VERSION: 3.x
jobs:
documentation:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Python runtime
uses: actions/setup-python@v1
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Install Python dependencies
run: |
pip install -r requirements.txt
- name: Install theme
run: |
pip install mkdocs-gitbook
- name: Deploy documentation
env:
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
run: |
mkdocs gh-deploy --force
mkdocs --version

View File

@ -15,28 +15,3 @@ jobs:
deploy-secret-key: ${{ secrets.OSSRH_GPG_SECRET_KEY }} deploy-secret-key: ${{ secrets.OSSRH_GPG_SECRET_KEY }}
deploy-secret-key-password: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} deploy-secret-key-password: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }}
mm-webhook-url: ${{ secrets.MATTERMOST_WEBHOOK_URL }} mm-webhook-url: ${{ secrets.MATTERMOST_WEBHOOK_URL }}
documentation:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Python runtime
uses: actions/setup-python@v1
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Install Python dependencies
run: |
pip install -r requirements.txt
- name: Install theme
run: |
pip install mkdocs-gitbook
- name: Deploy documentation
env:
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
run: |
mkdocs gh-deploy --force
mkdocs --version