Skip to content

Update documentation to use mkdocstring #32

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.

Sign up for GitHub

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

Merged
MatthewCane merged 1 commit into from
Nov 11, 2024
Merged

Update documentation to use mkdocstring #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
# Import the ntfy client
from python_ntfy import NtfyClient

# Optionally set your environment variables
from os import environ
environ["NTFY_USER"] = "your_username"
environ["NTFY_PASSWORD"] = "your_password"

# Create an `NtfyClient` instance with a topic
client = NtfyClient(topic="Your topic")

Expand Down
184 changes: 0 additions & 184 deletions docs/reference-auto.md
View file
Open in desktop

This file was deleted.

Loading