Skip to content

Commit

Permalink
docs: client.md
Browse files Browse the repository at this point in the history
  • Loading branch information
201st-Luka committed Sep 9, 2023
1 parent 57ad420 commit b90524b
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 15 deletions.
6 changes: 6 additions & 0 deletions docs/API Reference/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
nav:
- client.md
- exceptions.md
- api
- request_queue
- utils
1 change: 1 addition & 0 deletions docs/API Reference/client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: pyclasher.client
19 changes: 5 additions & 14 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ repo_url: https://github.com/201st-Luka/PyClasher
repo_name: 201st-Luka/PyClasher
docs_dir: docs

nav:
- Home: index.md

theme:
name: material
features:
Expand Down Expand Up @@ -51,19 +48,13 @@ plugins:
branch: master
token: !!python/object/apply:os.getenv ["MKDOCS_GIT_COMMITTERS_APIKEY"]
- mkdocstrings:
enabled: true
custom_templates: templates
default_handler: python
handlers:
python:
selection:
inherited_members: True
filters:
- "!^_"
rendering:
members_order: source
show_bases: True
show_root_toc_entry: False
group_by_category: True
heading_level: 3
show_if_no_docstring: True
options:
show_source: false

extra:
version:
Expand Down
2 changes: 1 addition & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mkdocs
mkdocs-material
mkdocs-git-committers-plugin
mkdocstrings
mkdocstrings[python]

0 comments on commit b90524b

Please sign in to comment.