Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@
<!-- ALL-CONTRIBUTORS-BADGE:END -->
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

Expand All @@ -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

Expand All @@ -53,14 +49,6 @@ monday.items.create_item(board_id='12345678', group_id='today', item_name='Do a

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

### Bug Reports
Expand Down
Loading