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
6 changes: 3 additions & 3 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ jobs:
pip install sphinx sphinx_rtd_theme myst_parser
- name: Sphinx build
run: |
sphinx-build doc _build
sphinx-build docs docs/_build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
publish_dir: docs/_build/html/
force_orphan: true
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
.DS_Store
dist/
build/
_build/
docs/_build/
.mypy_cache/
.ropeproject/
.vscode/
venv/
test.py
*.egg-info
*.egg-info
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
BUILDDIR = docs/_build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
Expand Down
20 changes: 14 additions & 6 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ Getting started

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')

Available methods
^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -119,12 +118,21 @@ Boards Resource (monday.boards)
as their ids, types, and settings. Accepts a comma separated list of
board ids.

- ``fetch_items_by_board_id([board_ids], **kwargs)`` - Get all items on
a board(s). Accepts a comma separated list of board ids.
- ``fetch_items_by_board_id([board_ids], **kwargs)`` - Get items on
a board(s) with manual pagination. Accepts a comma separated list of
board ids.

- ``limit`` - The number of rows returned (*int*. no default).
- ``limit`` - The number of rows returned (*int*. default 500).
- ``page`` - The page number returned, should you implement
pagination(*int*. no default).
pagination (*int*. no default).
- ``cursor`` - Token that can be used for pagination to ask for
next page.

- ``fetch_all_items_by_board_id([board_ids], **kwargs)`` - Get all items on
a board(s) without manual pagination. Accepts a comma separated list of
board ids.

- ``limit`` - The number of rows returned (*int*. default 500).

- ``create_board(board_name, board_kind, workspace_id)`` - Create board
with the given name and kind by (and optional) workspace id.
Expand Down
Binary file removed docs/_build/doctrees/README.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/_build/doctrees/index.doctree
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/_build/html/.buildinfo

This file was deleted.

4 changes: 0 additions & 4 deletions docs/_build/html/.buildinfo.bak

This file was deleted.

Binary file removed docs/_build/html/.doctrees/README.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/index.doctree
Binary file not shown.
308 changes: 0 additions & 308 deletions docs/_build/html/README.html

This file was deleted.

Loading
Loading