Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jagodek committed Nov 7, 2024
1 parent be901fd commit 869d637
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 12 deletions.
14 changes: 5 additions & 9 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ on:
branches: ["main"]
pull_request:
branches: [main]
paths:
- 'docs/**'
- 'pyproject.toml'
- 'mkdocs.yml'

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand All @@ -25,17 +29,15 @@ concurrency:
jobs:
# Single deploy job since we're just deploying
deploy:
runs-on: ubuntu-latest
env:
POETRY_VIRTUALENVS_CREATE: false
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
Expand All @@ -50,12 +52,6 @@ jobs:
run: mkdocs build
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact if on main
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: 'site'
- name: Deploy to GitHub Pages if on main
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/site
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Main page
3 changes: 0 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ plugins:
- literate-nav:
nav_file: SUMMARY.md
- section-index
- coverage:
page_name: coverage
html_report_dir: htmlcov
- render_swagger
- mkdocstrings:
enable_inventory: true
Expand Down

0 comments on commit 869d637

Please sign in to comment.