From b1e09b6d31977b17e8d686783f03bbd40f32b25a Mon Sep 17 00:00:00 2001 From: Andras Toth Date: Sun, 24 Aug 2025 23:04:31 +1000 Subject: [PATCH] Fix GitHub Pages workflow and publish docs there --- .github/workflows/documentation.yml | 17 +++++++++++++---- README.md | 16 ++-------------- 2 files changed, 15 insertions(+), 18 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 8e7c9c0..2cb275d 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -11,17 +11,26 @@ jobs: steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 + - name: Install dependencies run: | pip install sphinx sphinx_rtd_theme myst_parser - - name: Sphinx build + + - name: Build Sphinx HTML run: | - sphinx-build docs docs/_build + sphinx-build -b html docs docs/_build/html + + - name: Upload built docs as artifact + uses: actions/upload-artifact@v4 + with: + name: html-docs + path: docs/_build/html + - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 - if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} with: publish_branch: gh-pages github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: docs/_build/html/ + publish_dir: docs/_build/html force_orphan: true diff --git a/README.md b/README.md index c85dc7f..8ec66ae 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,8 @@ A monday.com Python Client Library - For an overview of the Monday API, [click here](https://developer.monday.com/api-reference/docs). - #### Requirements - Python >= 3.11 @@ -18,15 +16,13 @@ For an overview of the Monday API, [click here](https://developer.monday.com/api ```python from monday import MondayClient - monday = MondayClient('your token') -monday.items.create_item(board_id='12345678', group_id='today', item_name='Do a thing') - +monday.items.create_item(board_id='12345678', group_id='today', item_name='Do a thing') ``` ### Additional Resources and Code Samples -- Read our [docs](https://monday.readthedocs.io/en/latest/) for a full list of available resources and methods for interacting with those resources. +- Read our [docs](https://prodperfect.github.io/monday/) for a full list of available resources and methods for interacting with those resources. ## Contributors @@ -53,14 +49,6 @@ monday.items.create_item(board_id='12345678', group_id='today', item_name='Do a - - - - - - - - ### Bug Reports