Skip to content

Commit

Permalink
use mkdocs-material
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexandreGazagnes committed Feb 12, 2024
1 parent cd5d48c commit 2bf986e
Show file tree
Hide file tree
Showing 3 changed files with 192 additions and 38 deletions.
56 changes: 19 additions & 37 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,49 +6,31 @@ on:
pull_request:
branches: [ main]

permissions:
contents: write

jobs:

publish-documentation:

deploy:
runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
python-version: ["3.10.12",]
# python-version: ["3.8.1", "3.9.1", "3.10.12", "3.11.1", "3.12.1"]
poetry-version: ["1.7.0"]
# pandas-version: ["2.2.0", "2.1.0", "2.0.0", "1.5.0", "1.4.0", "1.3.0"]
# scikit-learn-version: ["1.4.0", "1.3.0", "1.2.0", "1.1.0", "1.0",]

# runs-on: ${{ matrix.os }}

steps:

- uses: actions/checkout@v4

- uses: actions/setup-python@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

- name: Run image
uses: abatilo/actions-poetry@v2
with:
poetry-version: ${{ matrix.poetry-version }}

- name: View poetry --help
run: poetry --help

- name: poetry Install
run: poetry install --only doc

- name: Run pwd
run: pwd

- name: Publish documentation
run: cd ./docs && poetry run mkdocs gh-deploy
env:
PACKAGE_DIRECTORY: "./sktransf/"
PYTHON_VERSION: "3.10.12"
ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PUBLISH_REGISTRY_PASSWORD: ${{ secrets.PUBLISH_REGISTRY_PASSWORD }}
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
Loading

0 comments on commit 2bf986e

Please sign in to comment.