Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an example notebook on how to use the sdk #32

Merged
merged 17 commits into from
Dec 7, 2023
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,6 @@ dmypy.json
.pyre/

.vscode/

# Mac OS-specific storage files
.DS_Store
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,9 @@ so:*
.. code-block:: console

$ export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib


Examples
--------------------------------
You can find examples of how to use the Python SDK here: `Notebooks <examples/notebooks>`_

2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".ipynb_checkpoints"]


# -- Options for HTML output -------------------------------------------------
Expand Down
7 changes: 7 additions & 0 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Examples
========
In our examples section, you can find Jupyter Notebooks and other material to help you get started:

`Notebooks <https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks>`_:

* `Introduction to the ENLYZE Python SDK <https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks/introduction_enlyze_python_sdk.ipynb>`_
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ User's Guide

installation
quickstart
examples
concepts
client
models
Expand Down
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ url
uuid
virtualenv
whitespace
Jupyter
Loading
Loading