Skip to content

Commit

Permalink
Merge pull request #19 from chmoder/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
chmoder authored Nov 6, 2022
2 parents a4c5fef + 1217850 commit 76b1808
Show file tree
Hide file tree
Showing 11 changed files with 131 additions and 6 deletions.
15 changes: 15 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
version: 2

build:
os: "ubuntu-20.04"
tools:
python: "3.9"

# Build from the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Explicitly set the version of Python and its requirements
python:
install:
- requirements: docs/requirements.txt
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
sys.path.insert(0, os.path.abspath(".."))

import strike_api
import strike_api.models

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
Expand All @@ -24,6 +25,7 @@
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinxcontrib.autodoc_pydantic",
"sphinx.ext.napoleon",
"sphinx.ext.doctest",
"sphinx.ext.intersphinx",
Expand Down Expand Up @@ -76,3 +78,4 @@
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration

todo_include_todos = True
autosummary_generate = True
5 changes: 2 additions & 3 deletions docs/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ strike_api
==========

.. toctree::
:maxdepth: 4
:caption: Contents:
:maxdepth: 4

strike_api
strike_api
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
autodoc-pydantic==1.8.0
pyhumps==3.8.0
77 changes: 77 additions & 0 deletions docs/strike_api.models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
strike\_api.models package
==========================

Submodules
----------

strike\_api.models.accounts module
----------------------------------

.. automodule:: strike_api.models.accounts
:members:
:undoc-members:
:show-inheritance:

strike\_api.models.errors module
--------------------------------

.. automodule:: strike_api.models.errors
:members:
:undoc-members:
:show-inheritance:

strike\_api.models.events module
--------------------------------

.. automodule:: strike_api.models.events
:members:
:undoc-members:
:show-inheritance:

strike\_api.models.generic module
---------------------------------

.. automodule:: strike_api.models.generic
:members:
:undoc-members:
:show-inheritance:

strike\_api.models.invoices module
----------------------------------

.. automodule:: strike_api.models.invoices
:members:
:undoc-members:
:show-inheritance:

strike\_api.models.quotes module
--------------------------------

.. automodule:: strike_api.models.quotes
:members:
:undoc-members:
:show-inheritance:

strike\_api.models.rates module
-------------------------------

.. automodule:: strike_api.models.rates
:members:
:undoc-members:
:show-inheritance:

strike\_api.models.subscriptions module
---------------------------------------

.. automodule:: strike_api.models.subscriptions
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: strike_api.models
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/strike_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,10 @@ Subscriptions
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: strike_api
:members:
:undoc-members:
:show-inheritance:
23 changes: 22 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ sphinx = "^5.3.0"
black = "^22.10.0"
sphinx-rtd-theme = "^1.0.0"
pytest-recording = "^0.12.1"
autodoc-pydantic = "^1.8.0"

[build-system]
requires = ["poetry-core"]
Expand Down
2 changes: 1 addition & 1 deletion strike_api/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def get_events(
) -> EventItems:
"""Gets a list of events matching optional search criteria.
Required scopes: partner.webhooks.manage
OData filtering syntax can be seen `here <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-odata/7d6c4117-317d-4860-915b-7e321be017e3>`_. Ordering syntax can be seen `here <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-odata/793b1e83-95ee-4446-8434-f5b634f20d1e>`_.
OData filtering syntax can be seen `here <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-odata/7d6c4117-317d-4860-915b-7e321be017e3>`_. Ordering syntax can be seen `here <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-odata/793b1e83-95ee-4446-8434-f5b634f20d1e>`__.
Args:
filter_ (typing.Optional[str], optional): Filter the results using OData syntax. Supported properties: created, eventType, deliverySuccess.. Defaults to None.
Expand Down
2 changes: 1 addition & 1 deletion strike_api/invoices.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def get_invoices(
) -> InvoiceItems:
"""Get invoices with optional search criteria.
Required scopes: partner.webhooks.manage
OData filtering syntax can be seen `here <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-odata/7d6c4117-317d-4860-915b-7e321be017e3>`_. Ordering syntax can be seen `here <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-odata/793b1e83-95ee-4446-8434-f5b634f20d1e>`_.
OData filtering syntax can be seen `here <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-odata/7d6c4117-317d-4860-915b-7e321be017e3>`_. Ordering syntax can be seen `here <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-odata/793b1e83-95ee-4446-8434-f5b634f20d1e>`__.
Args:
filter_ (typing.Optional[str], optional): Filter the results using OData syntax. Supported properties: invoiceId, created, currency, state, issuerId, receiverId, payerId, correlationId.. Defaults to None.
Expand Down
Empty file added strike_api/models/__init__.py
Empty file.

0 comments on commit 76b1808

Please sign in to comment.