(2.0.0) woohoo, first major version bump!
bunch of stuff this update, including a full documentation site (still a WIP) there is now a cache created whenever an instance of `FloweryAPI` is instantiated, so you don't have to query the api and iterate through the api response to retrieve a single voice anymore! function names have also been changed with this update, hence the major version bump. `get_tts()`, `get_voices()`, and `get_voice()` have been renamed to `fetch_tts()`, `fetch_voices()`, and `fetch_voice()` respectively. `get_voices()` still exists, but with different functionality (that method retrieves voices from the internal cache instead of querying the flowery api) !BREAKING
This commit is contained in:
parent
81dea4c8a2
commit
cb87400278
17 changed files with 1489 additions and 36 deletions
101
mkdocs.yml
Normal file
101
mkdocs.yml
Normal file
|
@ -0,0 +1,101 @@
|
|||
site_name: PyFlowery Documentation
|
||||
site_url: !ENV [SITE_URL, 'https://pyflowery.coastalcommits.com']
|
||||
repo_name: CoastalCommits
|
||||
repo_url: https://www.coastalcommits.com/cswimr/PyFlowery
|
||||
edit_uri: !ENV [EDIT_URI, 'src/branch/main/docs']
|
||||
copyright: Copyright © 2024, cswimr
|
||||
docs_dir: docs
|
||||
|
||||
site_author: cswimr
|
||||
site_description: PyFlowery is an asynchronous Python library for interacting with the Flowery API.
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Getting Started:
|
||||
- Installation: getting-started/installation.md
|
||||
- Usage: getting-started/usage.md
|
||||
- Reference:
|
||||
- FloweryAPI: ref/flowery.md
|
||||
- Exceptions: ref/exceptions.md
|
||||
- Models: ref/models.md
|
||||
- Rest Adapter: ref/rest_adapter.md
|
||||
|
||||
plugins:
|
||||
- git-authors
|
||||
- search
|
||||
- social
|
||||
- git-revision-date-localized:
|
||||
enable_creation_date: true
|
||||
type: timeago
|
||||
- mkdocstrings:
|
||||
default_handler: python
|
||||
handlers:
|
||||
python:
|
||||
options:
|
||||
docstring_options:
|
||||
ignore_imit_summary: true
|
||||
summary: true
|
||||
show_root_toc_entry: false
|
||||
filters:
|
||||
- "!^_"
|
||||
|
||||
markdown_extensions:
|
||||
- abbr
|
||||
- attr_list
|
||||
- md_in_html
|
||||
- tables
|
||||
- pymdownx.blocks.details
|
||||
- pymdownx.blocks.admonition
|
||||
- pymdownx.saneheaders
|
||||
- pymdownx.magiclink
|
||||
- pymdownx.mark
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- pymdownx.superfences
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
line_spans: __span
|
||||
pygments_lang_class: true
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||||
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
- media: '(prefers-color-scheme: light)'
|
||||
scheme: default
|
||||
primary: white
|
||||
accent: light blue
|
||||
toggle:
|
||||
icon: material/toggle-switch
|
||||
name: Switch to dark mode
|
||||
|
||||
- media: '(prefers-color-scheme: dark)'
|
||||
scheme: slate
|
||||
primary: black
|
||||
accent: light blue
|
||||
toggle:
|
||||
icon: material/toggle-switch-off-outline
|
||||
name: Switch to light mode
|
||||
features:
|
||||
- announce.dismiss
|
||||
- content.code.annotate
|
||||
- content.code.copy
|
||||
- navigation.instant
|
||||
- navigation.instant.progress
|
||||
- navigation.tracking
|
||||
- navigation.top
|
||||
- navigation.sections
|
||||
- navigation.indexes
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- search.share
|
||||
- toc.follow
|
||||
logo: img/logo.png
|
||||
favicon: img/logo.png
|
||||
icon:
|
||||
repo: simple/forgejo
|
||||
|
||||
watch:
|
||||
- ./pyflowery
|
Loading…
Add table
Add a link
Reference in a new issue