mirror of
https://github.com/valitydev/fraudo.git
synced 2024-11-06 01:45:16 +00:00
Add documentation (#26)
This commit is contained in:
parent
b090195a28
commit
9a019ddf56
30
.github/workflows/build-docs.yml
vendored
Normal file
30
.github/workflows/build-docs.yml
vendored
Normal 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
|
23
.github/workflows/build.yml
vendored
23
.github/workflows/build.yml
vendored
@ -8,26 +8,3 @@ on:
|
||||
jobs:
|
||||
build:
|
||||
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
34
.github/workflows/deploy-docs.yml
vendored
Normal 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
|
25
.github/workflows/deploy.yml
vendored
25
.github/workflows/deploy.yml
vendored
@ -15,28 +15,3 @@ jobs:
|
||||
deploy-secret-key: ${{ secrets.OSSRH_GPG_SECRET_KEY }}
|
||||
deploy-secret-key-password: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }}
|
||||
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
|
||||
|
Loading…
Reference in New Issue
Block a user