diff --git a/.github/workflows/mkdocs.yaml b/.github/workflows/mkdocs.yaml new file mode 100644 index 0000000..979800c --- /dev/null +++ b/.github/workflows/mkdocs.yaml @@ -0,0 +1,33 @@ +name: Deploy MkDocs to GitHub Pages + +on: + push: + branches: + - develop # Set this to your default branch + +jobs: + deploy: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.x' # Set this to the Python version you're using + + - name: Install dependencies + run: | + pip install mkdocs-material 'mkdocstrings[python]' + + - name: Build site + run: mkdocs build -f config/mkdocs.yml + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./site # Set this to your 'site_dir' if you have a custom build directory + cname: lapidary.dev diff --git a/config/mkdocs.yml b/config/mkdocs.yml new file mode 100644 index 0000000..37632ad --- /dev/null +++ b/config/mkdocs.yml @@ -0,0 +1,21 @@ +site_name: Lapidary +site_description: Build Web API clients with python annotations +copyright: © 2024 Rafał Krupiński +repo_url: https://github.com/python-lapidary/lapidary +repo_name: python-lapidary/lapidary + +docs_dir: ../docs +site_dir: ../site + +plugins: +- mkdocstrings: + handlers: + python: + paths: + - ../src + options: + docstring_style: sphinx + + +theme: + name: material